sqlsnip 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4691a62621199c780a25a27c14467e10ae3b48e2a20961a6f5660d5deab6b0aa
+  data.tar.gz: 7077d2b840173151db73d7bf038974791bbb5c4319e098d9741c2ef0b0b193b7
+SHA512:
+  metadata.gz: 4b9f2117d5242c5535a434e036c0a0926f399c3ef0cb31d6deac57f8c187048900cbba9d5d06f649fcd9bbebff95e8e172efab9713262f7422fb3157269c1b6d
+  data.tar.gz: 455d2f47f9be97fdc91e5d8b0f909a0846e19af94c3ad028550c2428373aee4c8febf923ad35743916b0aadc2d4ce544effebb491b568427744fc196fd27ffa6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.2

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sqlsnip.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,31 @@
+# Sqlsnip
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sqlsnip`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sqlsnip.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/sqlsnip

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'shellopts'
+require 'indented_io'
+
+require 'sqlsnip.rb'
+
+SPEC = %(
+  @ Pre-process a SQL snippet
+
+  -- 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)
+
+  The range is given by a start and a stop line number (inclusive) and 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
+
+  The whole file is also scanned for 'set search_path' statements to determine
+  the current schema at the beginning of the snippet. If not found the schema
+  is determined from the file name. It is assumed that the file exists in a
+  prick(1) directory hierarchy
+
+  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
+
+  EXAMPLE
+
+  sqlsnip can be used to create a vim macro in .vimrcc that executes the
+  selected text or the whole file:
+
+    \\function! ExecuteSqlFile() range
+      let path = expand('%:p')
+      let result = system('sqlsnip' . path . ' | psql')
+      echo result
+    endfunction
+
+    function! ExecuteSqlRange() range
+      let path = expand('%:p')
+      let start_line = line("'<")
+      let end_line = line("'>")
+      let result = system('sqlsnip ' . path . ' ' . start_line . ' ' . end_line . ' | psql')
+      echo result
+    endfunction
+
+    " CTRL+G - execute whole file
+    map <C-G> :call ExecuteSqlFile()<CR>
+
+    " 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"
+
+prg = Sqlsnip::Prg.new(file, start_line.to_i, stop_line.to_i)
+prg.run
+

data/lib/sqlsnip/version.rb

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

data/lib/sqlsnip.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require_relative "sqlsnip/version"
+
+module Sqlsnip
+  class Error < StandardError; end
+  
+  class Prg
+    UID_RE = /(?:[.\w]+)/
+    TABLE_MODIFIERS_RE = /(?:global|local|temporary|temp|unlogged)/
+    VIEW_MODIFIERS_RE = /(?:temp|temporary|recursive)/
+    IF_NOT_EXISTS_RE = /(?:if\s+not\s+exists)/
+    TRIGGER_MODIFIERS_RE = /(?:constraint)/
+
+    FUNCTION_ARGMODE_RE = /(?:in|out|inout|variadic)/
+    FUNCTION_ARGS_RE = /(?:#{FUNCTION_ARGMODE_RE}\s*,\s*)/
+    FUNCTION_DEFAULT_RE = /(?:default\s+.*)/
+
+    TABLE_RE = /(?:#{TABLE_MODIFIERS_RE}\s+)*table\s+(?:#{IF_NOT_EXISTS_RE}?\s+)?(#{UID_RE})/i
+    VIEW_RE = /(?:#{VIEW_MODIFIERS_RE}\s+)*view\s+(#{UID_RE})/i
+    FUNCTION_RE = /function\s+(#{UID_RE})\s*\((.*?)\)\s+(?:returns|$)/i
+    PROCEDURE_RE = /function\s+(#{UID_RE})\s*\((.*?)\)\s+(?:as|$)/i
+    TRIGGER_RE = /trigger\s+(#{UID_RE})\s+.*\s+on\s+(#{UID_RE})/i
+
+    DEFAULT_VALUE_RE = /(?:[^,\(]+(?:\([^\)]*\))?)/
+    DEFAULT_RE=/default\s+#{DEFAULT_VALUE_RE}/i
+
+    SEARCH_PATH_RE = /^\s*set\s+search_path/
+
+    attr_reader :file, :start_line, :stop_line
+    attr_reader :lines # The selected range of lines
+
+    def initialize(file, start_line, stop_line)
+      @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
+      @project_dir = nil
+    end
+
+    def run
+      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
+    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 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
+    end
+
+    def generate_drop_statements
+      has_search_path = false
+      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 
+              when TABLE_RE
+                table = $1
+                sql = "drop table if exists #{table} cascade;"
+              when VIEW_RE
+                view = $1
+                sql = "drop view if exists #{view} cascade;"
+              when FUNCTION_RE
+                function = $1
+                args_str = $2
+                # We assume that default values contain no commas
+                args = args_str.split(/\s*,\s*/).map { |arg|
+                  arg.sub(/^#{UID_RE}\s+/, "").sub(/\s+#{FUNCTION_DEFAULT_RE}/, "") 
+                }
+                sql = "drop function if exists #{function}(#{args.join(', ')}) cascade;"
+              when PROCEDURE_RE
+                procedure, args_str = $1, $2
+                # We assume that default values contain no commas
+                args = args_str.split(/\s*,\s*/).map { |arg|
+                  arg.sub(/^#{UID_RE}\s+/, "").sub(/\s+#{FUNCTION_DEFAULT_RE}/, "") 
+                }
+                sql = "drop procedure if exists #{procedure}(#{args.join(', ')}) cascade;"
+              when TRIGGER_RE
+                trigger, table = $1, $2
+                sql = "drop trigger if exists #{trigger} on #{table} cascade;"
+            else
+              next
+            end
+        else
+          next
+        end
+        stmts << sql
+      end
+      [stmts, has_search_path]
+    end
+  end
+end

data/sig/sqlsnip.rbs

@@ -0,0 +1,4 @@
+module Sqlsnip
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: sqlsnip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Claus Rasmussen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: indented_io
+  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: shellopts
+  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
+executables:
+- sqlsnip
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- exe/sqlsnip
+- lib/sqlsnip.rb
+- lib/sqlsnip/version.rb
+- sig/sqlsnip.rbs
+homepage: http://www.nowhere.com/
+licenses: []
+metadata:
+  homepage_uri: http://www.nowhere.com/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Gem sqlsnip
+test_files: []