live_sql 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54b7fcbd0ff4dcad2f1cceaa5364da65597caa06
-  data.tar.gz: f96754e32f6f59e747322dc02507aa01b29c0145
+  metadata.gz: 99f8b166541e4e08506407da8489e03e215fd309
+  data.tar.gz: fe379eafbe5cedc9f9a096397df3586b8041b993
 SHA512:
-  metadata.gz: df1290c2e5878ca6202b1d23d388c08d193360b857c80795fa98caf0bca7bc2d7b84c372a5de5c92a5e88b7dfb092680e896b351b04e70313e030b44541ca547
-  data.tar.gz: 06e8008ed6dbc71ccfd2743a457968d8222108bcdfe853a18631c6b18e42e216ff9de5a96f36dc1ee44d052fd1d337cea6f01905a0cf3d4b24ae26e48b84ee66
+  metadata.gz: b4959bf437934808eb258a11a9b4368b0e43b7e5c3b497a8e889f5ffe53bf520dd55c854a1e536b827ff897ec8997594b84f31dd5e51edff435023cbb09a7bdc
+  data.tar.gz: 3097213f35b819504d4b77df88e79a9e3537e8b3899cf4fe1173e9675c81161a18039c85da72ceae65873987021f5bc9ed7b111792e3219d7b13c15b74d5db78

data/.gitignore

@@ -7,3 +7,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+
+.DS_Store
+.byebug_history
+live_sql-*

data/README.md

@@ -1,6 +1,6 @@
 # LiveSql
 
-Hello friends! live_sql is a little program I wrote to watch how your sqlite queries change your results as you type. This is a baby gem. It's has a few known bugs, probably way more unknown bugs, not to mention it could use some sexy new features. If you want to contribute either by pointing out bugs, fixing problems. or adding new features, your help would be greatly appreciated!
+Hello friends! live_sql is a little program I wrote to watch how your SQL queries change your results as you type. This is a baby gem, so contributions are welcome! Fixing problems, adding new features, or reporting bugs is greatly appreciated!
 
 ## Installation
 
@@ -17,14 +17,27 @@ And then execute:
 Or install it yourself as:
 
     $ gem install live_sql
+
 ## Usage
 
-To use the test database, just download this repo and run bin/console. You can check out how it works with a simple actor, casting, and movie table.
+### Running from the Terminal
+To use with a postgres db, simply run:
+
+    live_sql your_database_name_here
+
+To use sqlite3 db, navigate to the folder containing the db and run
+
+    live_sql your_database_name_here.db sqlite3
+
 
-To use on any sqlite3 db, navigate to the folder containing the db, run pry (or irb) and
+### Using the class
 
-require 'live_sql'
-LiveSQL.run_with('your-db-name-here.db')
+The gem exposes the LiveSQL object. To open the interface create a new instance, and call the run method.
+
+```ruby
+options = { db: :sqlite3, limit: 40 }
+LiveSQL.new(your_database_name, options).run
+```
 
 ## Contributing
 
@@ -32,10 +45,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/fsladk
 
 ## Running list of bugs and potential features:
 
-  - Oh god, I already forgot the most recent bug. It'll come back to me....
-
-  - The most obvious extension is to get this thing hooked up to postgres as well as sqlite3.
+  - Allow aggregate functions to be included in select but not actually used in the query until a group by clause is added.
 
+  - Allow cursor navigation by holding down command/option for jumping words etc.
 
 ## License
 

data/exe/live_sql

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "live_sql"
+
+db_name = ARGV[0]
+options = { db: ARGV[1] && ARGV[1].to_sym }
+LiveSQL.new(db_name, options).run

data/lib/live_sql/cursorable.rb

@@ -0,0 +1,34 @@
+module Cursorable
+
+  def error
+  end
+
+  def quit
+    system("clear")
+    abort
+  end
+
+  def left
+    @cursor_pos -= 1 unless @cursor_pos == 0
+  end
+
+  def right
+    @cursor_pos += 1 unless @cursor_pos == @string.length - 1
+  end
+
+  def backspace
+    if @string.length > 1
+      @string.slice!(@cursor_pos - 1)
+      @cursor_pos -= 1 unless @cursor_pos == 0
+    end
+    attempt_to_query_db
+  end
+
+  def delete
+    if @string.length > 1
+      @string.slice!(@cursor_pos)
+    end
+    attempt_to_query_db
+  end
+
+end

data/lib/live_sql/interface.rb

@@ -1,7 +1,5 @@
 require 'io/console'
 
-# Reads keypresses from the user including 2 and 3 escape character sequences.
-
 class Interface
   attr_accessor :string
 
@@ -23,26 +21,15 @@ class Interface
 
   # oringal case statement from:
   # http://www.alecjacobson.com/weblog/?p=75
+  
   def get_keyboard_input
     c = read_char
 
     case c
-    # when " "
-    #   "SPACE"
-    # when "\t"
-    #   :query
     when "\r"
       :error
-    # when "\n"
-    #   "LINE FEED"
     when "\e"
-      :abort
-    # when "\e[A"
-    #   "UP ARROW"
-    #   :error
-    # when "\e[B"
-    #   "DOWN ARROW"
-    #   :error
+      :quit
     when "\e[C"
       "RIGHT ARROW"
       :right
@@ -51,13 +38,10 @@ class Interface
       :left
     when "\177"
       :backspace
-    # when "\004"
-    #   "DELETE"
-    # when "\e[3~"
-    #   "ALTERNATE DELETE"
-    # when "\u0003"
-    #   "CONTROL-C"
-    #   exit 0
+    when "\004"
+      :delete
+     when "\e[3~"
+       :delete
     when /^.$/
       c
     else

data/lib/live_sql/psql_dbconnection.rb

@@ -0,0 +1,18 @@
+require 'pg'
+
+class PostgresDatabaseConnection
+
+  def initialize(db)
+    @connection = PG.connect(dbname: db)
+    @connection.type_map_for_results = PG::BasicTypeMapForResults.new @connection
+  end
+
+  def execute(arg)
+    results = []
+    result = @connection.exec(arg)
+    result.each_row do |row|
+      results << Hash[result.fields.zip(row)]
+    end
+    results
+  end
+end

data/lib/live_sql/sqlite3_dbconnection.rb

@@ -0,0 +1,11 @@
+require 'sqlite3'
+
+class Sqlite3DatabaseConnection < SQLite3::Database
+
+  def initialize(db)
+    super(db)
+
+    self.results_as_hash = true
+    self.type_translation = true
+  end
+end

data/lib/live_sql/util.rb

@@ -0,0 +1,6 @@
+module Util
+
+  def aggregate_func_names
+    %w(AVG COUNT FIRST LAST MAX MIN SUM)
+  end
+end

data/lib/live_sql/version.rb

@@ -1,3 +1,3 @@
 module LiveSql
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/live_sql.rb

@@ -1,115 +1,123 @@
-require "live_sql/version"
-require "live_sql/interface"
-require 'singleton'
-require 'sqlite3'
+require_relative "./live_sql/version.rb"
+require_relative "./live_sql/interface.rb"
+require_relative "./live_sql/cursorable.rb"
+require_relative "./live_sql/util.rb"
+require_relative "./live_sql/sqlite3_dbconnection.rb"
+require_relative "./live_sql/psql_dbconnection.rb"
 require 'table_print'
 require 'colorize'
 
-
-class QuestionsDatabase < SQLite3::Database
-
-  def initialize(db)
-    super(db)
-
-    self.results_as_hash = true
-    self.type_translation = true
-  end
-end
-
 class LiveSQL
-  attr_accessor :result
+  include Cursorable
+  include Util
 
-  def self.run_default
-    live_sql = LiveSQL.new('./live_sql/default_db/movie.db')
-    live_sql.run
-  end
+  attr_accessor :result, :cursor_pos, :errors, :string, :state
+  attr_reader :db, :limit, :interface
 
-  def self.run_with(db_name)
-    live_sql = LiveSQL.new(db_name)
-    live_sql.run
-  end
+  def initialize(db, opts = {})
+    if opts[:db] == :sqlite3
+      @db = Sqlite3DatabaseConnection.new(db)
+    else
+      @db = PostgresDatabaseConnection.new(db)
+    end
 
-  def initialize(db)
     @interface = Interface.new
-    @db = QuestionsDatabase.new(db)
-
+    @limit = 30
     @string = " "
     @result = []
 
-    @move = :invalid
+    @state = :invalid
     @cursor_pos = 0
     @errors = []
   end
 
+
   def run
-    while true
+    loop do
       print_display
-      input = @interface.get_keyboard_input
+      input = interface.get_keyboard_input
       handle_input(input)
     end
   end
 
+  # private
+
   def handle_input(input)
-    if input == :abort
-      system("clear")
-      abort
-    elsif input == :error
-    elsif input == :right
-      @cursor_pos += 1 unless @cursor_pos == @string.length - 1
-    elsif input == :left
-      @cursor_pos -= 1 unless @cursor_pos == 0
-    elsif input == :backspace
-      if @string.length > 1
-        @string.slice!(@cursor_pos - 1)
-        @cursor_pos -= 1 unless @cursor_pos == 0
-      end
-      attempt_to_query_db
+    if input.is_a?(Symbol)
+      send(input)
     else
-      @string.insert(@cursor_pos, input)
-      @cursor_pos += 1
+      string.insert(cursor_pos, input)
+      self.cursor_pos += 1
       attempt_to_query_db
     end
   end
 
   def attempt_to_query_db
-    old_table = @result
-    @result = query_db(@string)
-    @mode = :valid
+    old_table = result
+    filter_aggregate_functions
+
+    self.result = query_db(string)
+    self.state = :valid
     rescue StandardError => e
-      @errors << e.message
-      @result = old_table
-      @mode = :invalid
+      errors << e.message
+      self.result = old_table
+      self.state = :invalid
+  end
+
+  def filter_aggregate_functions
+    if aggregate_func_names.any? { |func| string.upcase.include?(func) } && !terminated?
+      raise "Aggregate queries must be terminated with a semi-colon"
+    end
+  end
+
+  def terminated?
+    !!(string =~ /\;\s*$/)
+  end
+
+  def query_db(string)
+    return if string =~ /drop/i
+    db.execute(<<-SQL)
+    #{string}
+    LIMIT
+      #{limit}
+    SQL
   end
 
   def print_display
     system("clear")
+    prompt
+    render
+  end
+
+  def prompt
     puts "Enter a query!".underline.bold
     puts "Green is for a valid query, red for syntax error."
+    puts "Queries using AVG() or COUNT() must be terminated with a semi-colon."
     puts "The table always shows the last valid query."
     puts "Press esc to quit."
-    if @mode == :invalid
-      print @string[0...@cursor_pos].colorize(:red)
-      print @string[@cursor_pos].colorize(background: :cyan, color: :red)
-      print @string[@cursor_pos + 1..-1].colorize(:red)
-      puts
-    else
-      print @string[0...@cursor_pos].colorize(:green)
-      print @string[@cursor_pos].colorize(background: :cyan)
-      print @string[@cursor_pos + 1..-1].colorize(:green)
-      puts
-    end
+  end
+
+  def render
+    state == :invalid ? print_invalid_query : print_valid_query
     print_table
   end
 
-  def print_table
-    tp @result
+  def print_invalid_query
+    print @string[0...@cursor_pos].colorize(:red)
+    print @string[@cursor_pos].colorize(background: :cyan, color: :red)
+    print @string[@cursor_pos + 1..-1].colorize(:red)
+    puts
   end
 
-  def query_db(string)
-    @db.execute(<<-SQL)
-      #{string}
-      LIMIT 30
-    SQL
+  def print_valid_query
+    print @string[0...@cursor_pos].colorize(:green)
+    print @string[@cursor_pos].colorize(background: :cyan)
+    print @string[@cursor_pos + 1..-1].colorize(:green)
+    puts
+  end
+
+  def print_table
+    tp result
   end
 
 end

data/live_sql.gemspec

@@ -8,23 +8,22 @@ Gem::Specification.new do |spec|
   spec.version       = LiveSql::VERSION
   spec.authors       = ["Fred Sladkey"]
   spec.email         = ["fsladkey@gmail.com"]
+  spec.executables   = ["live_sql"]
 
-  spec.summary       = %q{Interact with sqlite3 db and watch your query as you type.}
+  spec.summary       = %q{Live updating database querying utility.}
+  spec.description   = %q{Interact with psql/sqlite3 database and watch your results change as you type the query.}
   spec.homepage      = "https://github.com/fsladkey/Live-SQL"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_dependency 'sqlite3'
-  spec.add_dependency 'colorize'
-  spec.add_dependency 'table_print'
+  spec.add_dependency 'sqlite3', '1.3.11'
+  spec.add_dependency 'pg', '0.18.4'
+  spec.add_dependency 'colorize', '0.7.7'
+  spec.add_dependency 'table_print', '1.5.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: live_sql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Fred Sladkey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-17 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,48 +42,64 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.4
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.7
 - !ruby/object:Gem::Dependency
   name: table_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 1.5.4
+description: Interact with psql/sqlite3 database and watch your results change as
+  you type the query.
 email:
 - fsladkey@gmail.com
-executables: []
+executables:
+- live_sql
 extensions: []
 extra_rdoc_files: []
 files:
@@ -93,13 +109,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- exe/live_sql
 - lib/live_sql.rb
-- lib/live_sql/default_db/.DS_Store
-- lib/live_sql/default_db/cats.db
-- lib/live_sql/default_db/movie.db
+- lib/live_sql/cursorable.rb
 - lib/live_sql/interface.rb
+- lib/live_sql/psql_dbconnection.rb
+- lib/live_sql/sqlite3_dbconnection.rb
+- lib/live_sql/util.rb
 - lib/live_sql/version.rb
 - live_sql.gemspec
 homepage: https://github.com/fsladkey/Live-SQL
@@ -125,5 +141,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Interact with sqlite3 db and watch your query as you type.
+summary: Live updating database querying utility.
 test_files: []

data/bin/console

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "live_sql"
-
-db = ARGV[0]
-db ||= './lib/live_sql/default_db/movie.db'
-
-live_sql = LiveSQL.new(db)
-live_sql.run
-
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require "pry"
-Pry.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here