squill 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe04730ead5ea933e96f55f1a46ec2bd12e2a8b8
+  data.tar.gz: 64328ab776f037b01a7cf189c0214c51dac17596
+SHA512:
+  metadata.gz: 692a546b15340488bccaf17e06c2e5c0b6a1320319a243a70fe971f63b866425e7761eebc4809d035eb0150ee0f376bd3b6e34685995edf229fda69651c06489
+  data.tar.gz: 10e9966c6edb9f3b9b5eb9a0ef4e0773591d4d6a93534f9f4a85478181e2029f4455936c5a97b53fa109c3bbb8e9a568e3d4f661bd33f49bca7a08c9490f6573

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in squill.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andy Beering 
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Squill
+
+A very lightweight tool for storing, searching and executing ad-hoc SQL.
+
+## Installation
+
+    $ gem install squill
+
+## Configuration
+
+Squill will sometimes want to open an editor for you to insert your SQL (if you're not adding from a file).  If you want to use an editor other than the default `vi` then you should set your editor environment variable.
+
+    $ export EDITOR="/path/to/editor"
+
+Squill was written to save me many many minutes of my life spent re-writing ad-hoc SQL I had already written which eventually added up to my entire existence. (Basically)
+
+You might want to try saving yourself even a bit more time with an alias.
+
+    $ alias sq='squill'
+
+## Usage
+
+### Full help on command-line
+
+    $ squill help
+
+### Adding Squills
+
+To add a squill:
+
+    $ squill add some-sql-i-wrote
+    $ squill a some-sql-i-wrote
+
+With no other options you will be prompted for a description and it will open your `$EDITOR` or simply `vi`. (See Configuration)
+
+Names are strings and can have any characters but I'd suggest you keep it simple or strange things might happen.  Who knows.
+
+To add a squill from a file:
+
+    $ squill add some-sql /path/to/ad-hoc.sql
+
+Descriptions can be input on the command-line:
+
+    $ squill add does-weird-stuff path/to/file.sql -d 'this sql does something strange'
+
+### Searching Squills
+
+To search squills by name and description use the search command:
+
+    $ squill search foo
+    $ squill s foo
+
+You can give multi-word search strings with quotes:
+
+    $ squill search 'from that_one_table'
+
+### Outputting Squill SQL
+
+Printing the SQL associated with the squill:
+
+    $ squill print some-sql
+    $ squill p some-sql
+    $ squill p some-sql | psql
+
+### Listing All Squills
+
+If you're having a hard time finding what you want sometimes its best to just list them all and stare blankly at your screen for a while.
+
+    $ squill list
+
+### Deleting Squills
+
+Eventually you wont need that SQL ever again.  Lucky you.
+
+    $ squill delete i-wish-it-was-all-of-them
+
+## Contributing
+
+1. Fork it ( https://github.com/abeering/squill/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+    t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/squill

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby -wU
+
+require 'squill'
+
+Squill::CLIClient.start(ARGV)

data/lib/squill.rb

@@ -0,0 +1,6 @@
+require "squill/version"
+require 'squill/cli'
+
+module Squill
+
+end

data/lib/squill/cli.rb

@@ -0,0 +1,124 @@
+require 'thor'
+require 'squill/squill_file'
+require 'squill/squill_file_searcher'
+
+module Squill
+  class CLIClient < Thor
+
+    include Thor::Actions
+
+    desc "add <name> (<file>)", "Adds a file to squill library."
+    long_desc <<-ADD_DESC
+    Adds sql in <file> to squill library with name <name>.
+    If no <file> is given, will open your EDITOR or `vi` by default to get SQL.
+
+    Examples:
+
+      Add a squill and prompt for the description and SQL:
+
+      `squill add just-some-sql`
+
+      Add a squill from a file:
+
+      `squill add just-some-sql path/to/file.sql`
+
+      Include a description:
+
+      `squill add does-weird-stuff path/to/file.sql -d 'this sql does something strange'`
+    ADD_DESC
+    option :desc, :type => :string, :aliases => :d, :desc => "Can take a description on command-line instead of opening EDITOR for description body."
+    option :replace, :type => :boolean, :aliases => :r, :desc => "Replaces a squill named <name> which already exists."
+    def add(name, file=nil)
+      squill_file = Squill::SquillFile.new(name)
+      if squill_file.exists_as_squill_file? && !options[:replace]
+        puts "\na squill by this name already exists. use the the --replace option to replace it.\n"
+        return
+      end
+      squill_file.description = options[:desc].nil? ? ask("Briefly describe #{name}: ") : options[:desc]
+      if file.nil?
+        squill_file.set_sql
+      else
+        squill_file.set_sql_from_file(file)
+      end
+      squill_file.save
+      puts "\nsaved squill #{name}.\n"
+    end
+    map "a" => "add"
+
+    desc "print <name>", "Outputs file from squill library."
+    long_desc <<-RUN_DESC
+    Adds sql in <file> to Squill library with name <name>.
+    If no description option is given, will open the EDITOR set in your environment.
+
+    Example:
+
+      `squill run just-some-sql`
+    RUN_DESC
+    def print(name)
+      squill_file = Squill::SquillFile.new(name)
+      if squill_file.exists_as_squill_file?
+        puts squill_file.sql
+      end
+    end
+    map "p" => "print"
+
+    desc "search <string>", "Searches for squills whose name or description match <string>."
+    long_desc <<-SEARCH_DESC
+    Adds sql in <file> to Squill library with name <name>.
+    If no description option is given, will open the EDITOR set in your environment.
+
+    Example:
+
+      `squill search some_table`
+    SEARCH_DESC
+    def search(search_string)
+      searcher = Squill::SquillFileSearcher.new
+      results = searcher.search(search_string)
+      results.each { |result|
+        puts "#{result[:name_highlight]} - #{result[:description_highlight]}"
+      }
+      puts "\nfound #{results.length} squills.\n"
+    end
+    map "s" => "search"
+
+    desc "delete <name>", "Deletes squill with name matching <name>."
+    long_desc <<-DELETE_DESC
+    Deletes squill matching <name>.
+
+    Example:
+
+      `squill delete some-sql`
+    DELETE_DESC
+    def delete(name)
+      squill_file = Squill::SquillFile.new(name)
+      if squill_file.exists_as_squill_file?
+        if yes?("are you sure you want to delete #{name}?")
+          squill_file.delete
+          puts "\nsquill #{name} deleted.\n"
+        end
+      else
+        puts "\ncould not find squill named #{name} to delete.\n"
+      end
+    end
+    map "d" => "delete"
+
+    desc "list", "Lists all squills."
+    long_desc <<-LIST_DESC
+    Lists all available squills.
+
+    Example:
+
+      `squill list`
+    LIST_DESC
+    def list
+      searcher = Squill::SquillFileSearcher.new
+      results = searcher.list
+      results.each { |result|
+        puts "#{result.name} - #{result.description}"
+      }
+      puts "\nlisted #{results.length} squills.\n"
+    end
+    map "l" => "list"
+
+  end
+end

data/lib/squill/squill_file.rb

@@ -0,0 +1,116 @@
+module Squill
+  class SquillFile
+
+    attr_accessor :description, :sql, :name
+
+    def initialize(name)
+      ensure_squill_dir
+      @name = name
+      if exists_as_squill_file?
+        load_from_squill_file
+      end
+    end
+
+    def load_from_squill_file
+      orig_file = File.open(squill_file, "r")
+      content = orig_file.read
+      @description = content.match(/#Description: (.+?)\n/m)[1]
+      @sql = content.match(/#SQL:\n(.+?)#ENDSQL;/m)[1]
+      orig_file.close
+    end
+
+    def exists_as_squill_file?
+      File.exist?(squill_file)
+    end
+
+    def set_sql_from_file(filename)
+      orig_file = File.open(filename, "r")
+      @sql = orig_file.read
+      orig_file.close
+    end
+
+    def set_sql
+      prep_tempfile_for_sql
+      set_tempfile
+      @sql = read_tempfile_for_sql
+    end
+
+    def save
+      write_file
+    end
+
+    def delete
+      File.delete(squill_file)
+    end
+
+    def yaml
+      { name: @name, description: @description, sql: @sql }
+    end
+
+    private
+
+    def prep_tempfile_for_sql
+      file = File.open(tempfile, "w")
+      file.write <<-SQL_TEMPLATE
+
+#ENDSQL;
+# Insert SQL to be added to squill above these commented lines
+      SQL_TEMPLATE
+      file.close
+    end
+
+    def read_tempfile_for_sql
+      file = File.open(tempfile, "r")
+      sql = ""
+      file.each_line { |line|
+        break if line.match(/^#ENDSQL;/)
+        sql << line
+      }
+      file.close
+      sql
+    end
+
+    def set_tempfile
+      system(user_editor, tempfile)
+    end
+
+    def write_file
+      file = File.open(squill_file, "w")
+      file.write(contents_for_squill_file_write)
+      file.close
+    end
+
+    def contents_for_squill_file_write
+      <<-OUTPUT_FILE
+#Name: #{@name}
+#Description: #{@description}
+#SQL:
+#{@sql}
+#ENDSQL;
+      OUTPUT_FILE
+    end
+
+    def user_editor
+      !ENV['EDITOR'].nil? && !ENV['EDITOR'].empty? ? ENV['EDITOR'] : 'vi'
+    end
+
+    def ensure_squill_dir
+      if !File.directory?(squill_dir)
+        Dir.mkdir(squill_dir)
+      end
+    end
+
+    def tempfile
+      File.join(squill_dir, '.temp')
+    end
+
+    def squill_file
+      File.join(squill_dir, "#{name}.squill")
+    end
+
+    def squill_dir
+      File.join(File.expand_path('~'),'.squill')
+    end
+
+  end
+end

data/lib/squill/squill_file_searcher.rb

@@ -0,0 +1,35 @@
+module Squill
+  class SquillFileSearcher
+
+    def search(search_string)
+      grep_results = `egrep -l '^#(Description|Name):.*#{search_string}.*$' #{search_argument} | sort`
+      grep_results.split("\n").map { |result|
+        squillfile = Squill::SquillFile.new(File.basename(result.strip).gsub(/.squill/,''))
+        {
+          name_highlight: highlight(squillfile.name, search_string),
+          description_highlight: highlight(squillfile.description, search_string)
+        }
+      }
+    end
+
+    def list
+      results = `find #{squill_search_dir} -type f -name '*.squill' | sort`
+      results.split("\n").map { |result| Squill::SquillFile.new(File.basename(result.strip).gsub(/.squill/,'')) }
+    end
+
+    private
+
+    def highlight(string, search_string)
+      string.gsub(/(#{search_string})/) { |found| "\e[1m#{found}\e[0m" }
+    end
+
+    def search_argument
+      File.join(squill_search_dir,'*')
+    end
+
+    def squill_search_dir
+      File.join(File.expand_path('~'),'.squill')
+    end
+
+  end
+end

data/lib/squill/version.rb

@@ -0,0 +1,3 @@
+module Squill
+  VERSION = "0.0.1"
+end

data/squill.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'squill/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "squill"
+  spec.version       = Squill::VERSION
+  spec.authors       = ["Andy Beering"]
+  spec.email         = ["andy.beering@gmail.com"]
+  spec.summary       = %q{Simple CLI tool for storing, searching and executing ad-hoc SQL.}
+  spec.description   = %q{Simple CLI tool for storing, searching and executing ad-hoc SQL.}
+  spec.homepage      = "https://github.com/abeering/squill"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: squill
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Beering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple CLI tool for storing, searching and executing ad-hoc SQL.
+email:
+- andy.beering@gmail.com
+executables:
+- squill
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/squill
+- lib/squill.rb
+- lib/squill/cli.rb
+- lib/squill/squill_file.rb
+- lib/squill/squill_file_searcher.rb
+- lib/squill/version.rb
+- squill.gemspec
+homepage: https://github.com/abeering/squill
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple CLI tool for storing, searching and executing ad-hoc SQL.
+test_files: []