execute_sql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d044ff6ed461e770b7cbdab32ae3631f63b67770d8bfac0db8c9b262d2921bb
+  data.tar.gz: daceaad6d0633c7567783e213a73c23911798010609ebb4e71ba539530f7daff
+SHA512:
+  metadata.gz: acb0057884f0562a44c564e4bdf68b2db53510c0daab1368fe83fd8fbf6908d3f62424c7273e06c531d821cf60927b4808d3e0255675e22f77b53e9fbcdb7094
+  data.tar.gz: 5bec6886e112aa42fcbd6c5727e563717b93ccda3651903cac3fa339b2b2f7adb1f066f9beb681db069ddb85067d72ec2553e0a8d09a8b09750b68316755f53b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Igor Kasyanchuk
+
+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,73 @@
+# Rails Execute SQL
+
+Execute SQL with `execute_sql` helper inside your Rails apps. Directly in `rails console`.
+
+ <img src="https://github.com/igorkasyanchuk/execute_sql/blob/master/docs/sample_execute_sql.png?raw=true" width="60%" />
+
+## Usage
+
+Simply add this gem into your Gemfile.
+
+And for example call directly in `rails console`:
+
+```ruby
+execute_sql "select count(*) from users where age > 50"
+
+# see below for additional options.
+```
+
+OR in your models, controllers, or other parts of app:
+
+```ruby
+ExecuteSQL.run "select count(*) from users where age > 50"
+
+# or with different mode
+# default mode: :print
+
+# return single value
+ExecuteSQL.run "select count(*) from users where age > 50", mode: :single
+
+# return array of results
+ExecuteSQL.run "select * from users where age > 50", mode: :raw
+
+# just execute and return nil
+ExecuteSQL.run "truncate table users", mode: :none
+```
+
+Sample in controller:
+
+```ruby
+class HomeController < ApplicationController
+  def index
+    @users = ExecuteSql.run "select * from users", mode: :raw
+  end
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'execute_sql'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Options and modes
+
+You can call:
+
+In rails console use helper: `execute_sql "some SQL"`.
+
+Or `ExecuteSql.run "some SQL"` or `ExecuteSQL.run "some SQL"`.
+
+## Contributing
+
+You are welcome to contribute.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ExecuteSql'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/execute_sql/adapters/base_adapter.rb

@@ -0,0 +1,49 @@
+module ExecuteSql
+  module Adapters
+
+    class BaseAdapter
+      extend ::ExecuteSql::Connection
+
+      MULTI_STATEMENT_HELP_TEXT = "EXPERIMENTAL: You can import only file with SQL statements separated by ';'. Each new statement must start from new line."
+
+      def self.execute(sql)
+        t0 = Time.now
+        connection.execute(sql)
+        Time.now - t0
+      end
+
+      def self.exec_query(sql)
+        t0 = Time.now
+        results = connection.exec_query(sql)
+        execution_time = Time.now - t0
+        [results, execution_time]
+      end
+
+      def self.select(sql)
+        BaseAdapter.exec_query(sql)
+      end
+
+      def self.explain(sql)
+        BaseAdapter.exec_query(sql)
+      end
+
+      def self.adapter_name
+        'base'
+      end
+
+      def self.mime
+        'text/x-sql'
+      end
+
+      private
+
+      def self.multiple_execute(sql, divider = ";\n")
+        sql.split(divider).each do |statement|
+          connection.execute(statement)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/execute_sql/adapters/mysql.rb

@@ -0,0 +1,31 @@
+module ExecuteSql
+  module Adapters
+
+    class Mysql < BaseAdapter
+
+      def self.execute(sql)
+        t0 = Time.now
+        multiple_execute(sql)
+        Time.now - t0
+      end
+
+      def self.exec_query(sql, log = true)
+        t0      = Time.now
+        results = connection.execute(sql, 'SQL') # used from RoR mysql adapter source
+        result  = MysqlResult.new(results)
+        execution_time = Time.now - t0
+        [result, execution_time]
+      end
+
+      def self.adapter_name
+        'mysql'
+      end
+
+      def self.mime
+        'text/x-mysql'
+      end
+
+    end
+
+  end
+end

data/lib/execute_sql/adapters/postgres.rb

@@ -0,0 +1,17 @@
+module ExecuteSql
+  module Adapters
+
+    class Postgres < BaseAdapter
+
+      def self.adapter_name
+        'postgres'
+      end
+
+      def self.mime
+        'text/x-plsql'
+      end
+
+    end
+
+  end
+end

data/lib/execute_sql/adapters/sqlite.rb

@@ -0,0 +1,19 @@
+module ExecuteSql
+  module Adapters
+
+    class Sqlite < BaseAdapter
+
+      def self.execute(sql)
+        t0 = Time.now
+        multiple_execute(sql)
+        Time.now - t0
+      end
+
+      def self.adapter_name
+        'sqlite'
+      end
+
+    end
+
+  end
+end

data/lib/execute_sql/blank_results.rb

@@ -0,0 +1,8 @@
+module ExecuteSql
+  class BlankResults
+
+    def rows; [] end
+    def columns; [] end
+
+  end
+end

data/lib/execute_sql/connection.rb

@@ -0,0 +1,25 @@
+module ExecuteSql
+  module Connection
+
+    def connection
+      ActiveRecord::Base.connection
+    end
+
+    def columns
+      connection.columns(name)
+    end
+
+    def column_properties
+      %w(name sql_type null limit precision scale type default)
+    end
+
+    def to_param
+      name
+    end
+
+    def column_names
+      columns.collect(&:name)
+    end
+
+  end
+end

data/lib/execute_sql/database.rb

@@ -0,0 +1,26 @@
+module ExecuteSql
+  class Database
+    extend Connection
+
+    class << self
+      delegate :execute,     to: :adapter
+      delegate :select,      to: :adapter
+      delegate :explain,     to: :adapter
+      delegate :exec_query,  to: :adapter
+    end
+
+    def self.adapter
+      case connection.class.to_s
+      when /Mysql/
+        ExecuteSql::Adapters::Mysql
+      when /Postgre/
+        ExecuteSql::Adapters::Postgres
+      when /SQLite/
+        ExecuteSql::Adapters::Sqlite
+      else
+        ExecuteSql::Adapters::BaseAdapter
+      end
+    end
+
+  end
+end

data/lib/execute_sql/execute_sql_error.rb

@@ -0,0 +1,4 @@
+module ExecuteSql
+  class ExecuteSqlError < StandardError
+  end
+end

data/lib/execute_sql/mysql_result.rb

@@ -0,0 +1,18 @@
+module ExecuteSql
+  class MysqlResult
+
+    attr_reader :columns, :rows
+
+    delegate :each,  to: :rows
+
+    def initialize(result)
+      @columns = []
+      @rows    = []
+      if result
+        @columns = result.fields
+        @rows    = result.entries
+      end
+    end
+
+  end
+end

data/lib/execute_sql/railtie.rb

@@ -0,0 +1,9 @@
+module ExecuteSql
+  class Railtie < ::Rails::Railtie
+
+    console do
+      TOPLEVEL_BINDING.eval('self').extend ExecuteSql::ConsoleMethods
+    end
+
+  end
+end

data/lib/execute_sql/result.rb

@@ -0,0 +1,19 @@
+module ExecuteSql
+  class Result
+
+    attr_reader :error
+
+    def initialize(error)
+      @error = error
+    end
+
+    def self.ok
+      Result.new(nil)
+    end
+
+    def ok?
+      error.nil?
+    end
+
+  end
+end

data/lib/execute_sql/sql_explain.rb

@@ -0,0 +1,9 @@
+module ExecuteSql
+  class SqlExplain < SqlQueryData
+
+    def sql
+      "EXPLAIN #{super}"
+    end
+
+  end
+end

data/lib/execute_sql/sql_import.rb

@@ -0,0 +1,26 @@
+module ExecuteSql
+  class SqlImport
+    include Connection
+
+    attr_reader :time, :result
+
+    def initialize(file)
+      @file = file
+    end
+
+    def valid?
+      if @file.nil?
+        raise ExecuteSqlError.new('Please select valid SQL file and continue')
+      end
+    end
+
+    def import
+      valid?
+      @time   = Database.adapter.execute(@file.read)
+      @result = Result.ok
+    rescue ExecuteSqlError, ActiveRecord::StatementInvalid => e
+      @result = Result.new(e)
+    end
+
+  end
+end

data/lib/execute_sql/sql_query.rb

@@ -0,0 +1,42 @@
+module ExecuteSql
+  class SqlQuery
+    include Connection
+
+    attr_reader :query, :data, :explain, :sql_explain
+
+    def initialize(query, sql_explain = false)
+      @query       = query
+      @sql_explain = sql_explain
+    end
+
+    def valid?
+      query.present?
+    end
+
+    def load_explain
+      @explain ||= SqlExplain.new(self).load_data
+    end
+
+    def load_data
+      @data    ||= SqlQueryData.new(self).load_data
+    end
+
+    def execute
+      if valid?
+        load_data
+        load_explain if sql_explain
+      end
+      self
+    end
+
+    def to_csv
+      CSV.generate do |csv|
+        csv << data.columns
+        data.rows.each do |row|
+          csv << row
+        end
+      end
+    end
+
+  end
+end

data/lib/execute_sql/sql_query_data.rb

@@ -0,0 +1,36 @@
+module ExecuteSql
+  class SqlQueryData
+
+    attr_reader :sql_query, :time, :columns, :rows, :error
+
+    def initialize(sql_query)
+      @rows    = []
+      @columns = []
+      @sql_query = sql_query
+    end
+
+    def load_data
+      result, @time = Database.adapter.exec_query(sql)
+      @columns      = result.columns
+      @rows         = result.rows
+      self
+    rescue ActiveRecord::StatementInvalid => e
+      @columns, @rows = [], []
+      @error = e
+      self
+    end
+
+    def count
+      rows.count
+    end
+
+    def is_error?
+      error.present?
+    end
+
+    def sql
+      sql_query.query
+    end
+
+  end
+end

data/lib/execute_sql/version.rb

@@ -0,0 +1,3 @@
+module ExecuteSql
+  VERSION = '0.1.0'
+end

data/lib/execute_sql.rb

@@ -0,0 +1,51 @@
+require 'terminal-table'
+
+require_relative 'execute_sql/connection'
+require_relative 'execute_sql/database'
+require_relative 'execute_sql/blank_results'
+require_relative 'execute_sql/mysql_result'
+require_relative 'execute_sql/result'
+require_relative 'execute_sql/execute_sql_error'
+
+require_relative 'execute_sql/sql_query_data'
+require_relative 'execute_sql/sql_explain'
+require_relative 'execute_sql/sql_import'
+require_relative 'execute_sql/sql_query'
+
+require_relative 'execute_sql/adapters/base_adapter'
+require_relative 'execute_sql/adapters/mysql'
+require_relative 'execute_sql/adapters/postgres'
+require_relative 'execute_sql/adapters/sqlite' 
+
+require "execute_sql/railtie"
+
+module ExecuteSql
+  module ConsoleMethods
+    
+    def execute_sql(sql, mode: :print)
+      sql_query = ExecuteSql::SqlQuery.new("#{sql}".strip).execute
+      rows = sql_query.data.rows
+      cols = sql_query.data.columns
+      case mode.to_s
+      when 'print'
+        puts Terminal::Table.new(rows: rows, headings: cols)
+      when 'raw'
+        rows
+      when 'single'
+        rows.flatten[0]
+      when 'none'
+        nil
+      else
+        []
+      end
+    end
+
+    def run(sql, *args)
+      execute_sql(sql, *args)
+    end
+  end
+
+  extend ConsoleMethods
+end
+
+ExecuteSQL = ExecuteSql

data/lib/tasks/execute_sql_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :execute_sql do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: execute_sql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: terminal-table
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  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: Execute SQL directly in rails console or in the code.
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/execute_sql.rb
+- lib/execute_sql/adapters/base_adapter.rb
+- lib/execute_sql/adapters/mysql.rb
+- lib/execute_sql/adapters/postgres.rb
+- lib/execute_sql/adapters/sqlite.rb
+- lib/execute_sql/blank_results.rb
+- lib/execute_sql/connection.rb
+- lib/execute_sql/database.rb
+- lib/execute_sql/execute_sql_error.rb
+- lib/execute_sql/mysql_result.rb
+- lib/execute_sql/railtie.rb
+- lib/execute_sql/result.rb
+- lib/execute_sql/sql_explain.rb
+- lib/execute_sql/sql_import.rb
+- lib/execute_sql/sql_query.rb
+- lib/execute_sql/sql_query_data.rb
+- lib/execute_sql/version.rb
+- lib/tasks/execute_sql_tasks.rake
+homepage: https://github.com/igorkasyanchuk/execute_sql
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Execute SQL directly in rails console or in the code.
+test_files: []