daru-io 0.1.0

data/lib/daru/io/importers/sql.rb

@@ -0,0 +1,127 @@
+require 'daru/io/importers/base'
+
+module Daru
+  module IO
+    module Importers
+      # SQL Importer Class, that extends `from_sql` and `read_sql` methods to `Daru::DataFrame`
+      class SQL < Base
+        Daru::DataFrame.register_io_module :from_sql, self
+        Daru::DataFrame.register_io_module :read_sql, self
+
+        # Checks for required gem dependencies of SQL Importer
+        def initialize
+          optional_gem 'dbd-sqlite3', requires: 'dbd/SQLite3'
+          optional_gem 'activerecord', '~> 4.0', requires: 'active_record'
+          optional_gem 'dbi'
+          optional_gem 'sqlite3'
+        end
+
+        # Loads from a DBI connection
+        #
+        # @!method self.from(dbh)
+        #
+        # @param dbh [DBI::DatabaseHandle] A DBI connection.
+        #
+        # @return [Daru::IO::Importers::SQL]
+        #
+        # @example Importing from a DBI connection
+        #   instance = Daru::IO::Importers::SQL.from(DBI.connect("DBI:Mysql:database:localhost", "user", "password"))
+        def from(dbh)
+          @dbh = dbh
+          self
+        end
+
+        # Reads from a sqlite.db file
+        #
+        # @!method self.read(path)
+        #
+        # @param path [String] Path to a SQlite3 database file.
+        #
+        # @return [Daru::IO::Importers::SQL]
+        #
+        # @example Reading from a sqlite.db file
+        #   instance = Daru::IO::Importers::SQL.read('path/to/sqlite.db')
+        def read(path)
+          @dbh = attempt_sqlite3_connection(path) if Pathname(path).exist?
+          self
+        end
+
+        # Imports a `Daru::DataFrame` from SQL Importer instance
+        #
+        # @param query [String] The query to be executed
+        #
+        # @return [Daru::DataFrame]
+        #
+        # @example Importing with a SQL query
+        #   df = instance.call("SELECT * FROM test")
+        #
+        #   #=> #<Daru::DataFrame(2x3)>
+        #   #      id  name   age
+        #   # 0     1 Homer    20
+        #   # 1     2 Marge    30
+        def call(query)
+          @query          = query
+          @conn, @adapter = choose_adapter(@dbh, @query)
+          df_hash         = result_hash
+          Daru::DataFrame.new(df_hash).tap(&:update)
+        end
+
+        private
+
+        def attempt_sqlite3_connection(db)
+          DBI.connect("DBI:SQLite3:#{db}")
+        rescue SQLite3::NotADatabaseException
+          raise ArgumentError, "Expected #{db} to point to a SQLite3 database"
+        end
+
+        def choose_adapter(db, query)
+          query = String.try_convert(query) or
+            raise ArgumentError, "Query must be a string, #{query.class} received"
+
+          case db
+          when DBI::DatabaseHandle
+            [db, :dbi]
+          when ::ActiveRecord::ConnectionAdapters::AbstractAdapter
+            [db, :activerecord]
+          else
+            raise ArgumentError, "Unknown database adapter type #{db.class}"
+          end
+        end
+
+        def column_names
+          case @adapter
+          when :dbi
+            result.column_names
+          when :activerecord
+            result.columns
+          end
+        end
+
+        def result
+          case @adapter
+          when :dbi
+            @conn.execute(@query)
+          when :activerecord
+            @conn.exec_query(@query)
+          end
+        end
+
+        def result_hash
+          column_names
+            .map(&:to_sym)
+            .zip(rows.transpose)
+            .to_h
+        end
+
+        def rows
+          case @adapter
+          when :dbi
+            result.to_a.map(&:to_a)
+          when :activerecord
+            result.cast_values
+          end
+        end
+      end
+    end
+  end
+end

data/lib/daru/io/link.rb

@@ -0,0 +1,80 @@
+module Daru
+  class DataFrame
+    class << self
+      # Links `Daru::DataFrame` Import / Export methods to corresponding
+      # `Daru::IO` Importer / Exporter classes. Here is the list of linkages:
+      #
+      # #### Importers
+      #
+      # | `Daru::DataFrame` method            | `Daru::IO::Importers` class              |
+      # | ----------------------------------- | -----------------------------------------|
+      # | `Daru::DataFrame.from_activerecord` | {Daru::IO::Importers::ActiveRecord#from} |
+      # | `Daru::DataFrame.read_avro`         | {Daru::IO::Importers::Avro#read}         |
+      # | `Daru::DataFrame.read_csv`          | {Daru::IO::Importers::CSV#read}          |
+      # | `Daru::DataFrame.read_excel`        | {Daru::IO::Importers::Excel#read},       |
+      # |                                     |  {Daru::IO::Importers::Excelx#read}      |
+      # | `Daru::DataFrame.read_html`         | {Daru::IO::Importers::HTML#read}         |
+      # | `Daru::DataFrame.from_json`         | {Daru::IO::Importers::JSON#from}         |
+      # | `Daru::DataFrame.read_json`         | {Daru::IO::Importers::JSON#read}         |
+      # | `Daru::DataFrame.from_mongo`        | {Daru::IO::Importers::Mongo#from}        |
+      # | `Daru::DataFrame.read_plaintext`    | {Daru::IO::Importers::Plaintext#read}    |
+      # | `Daru::DataFrame.read_rdata`        | {Daru::IO::Importers::RData#read}        |
+      # | `Daru::DataFrame.read_rds`          | {Daru::IO::Importers::RDS#read}          |
+      # | `Daru::DataFrame.from_redis`        | {Daru::IO::Importers::Redis#from}        |
+      # | `Daru::DataFrame.from_sql`          | {Daru::IO::Importers::SQL#from}          |
+      #
+      # #### Exporters
+      #
+      # | `Daru::DataFrame` instance method | `Daru::IO::Exporters` class        |
+      # | --------------------------------- | -----------------------------------|
+      # | `Daru::DataFrame.to_avro_string`  | {Daru::IO::Exporters::Avro#to_s}   |
+      # | `Daru::DataFrame.write_avro`      | {Daru::IO::Exporters::Avro#write}  |
+      # | `Daru::DataFrame.to_csv_string`   | {Daru::IO::Exporters::CSV#to_s}    |
+      # | `Daru::DataFrame.write_csv`       | {Daru::IO::Exporters::CSV#write}   |
+      # | `Daru::DataFrame.to_excel_string` | {Daru::IO::Exporters::Excel#to_s}  |
+      # | `Daru::DataFrame.write_excel`     | {Daru::IO::Exporters::Excel#write} |
+      # | `Daru::DataFrame.to_json`         | {Daru::IO::Exporters::JSON#to}     |
+      # | `Daru::DataFrame.to_json_string`  | {Daru::IO::Exporters::JSON#to_s}   |
+      # | `Daru::DataFrame.write_json`      | {Daru::IO::Exporters::JSON#write}  |
+      # | `Daru::DataFrame.to_rds_string`   | {Daru::IO::Exporters::RDS#to_s}    |
+      # | `Daru::DataFrame.write_rds`       | {Daru::IO::Exporters::RDS#write}   |
+      # | `Daru::DataFrame.to_sql`          | {Daru::IO::Exporters::SQL#to}      |
+      #
+      # @param function [Symbol] Functon name to be monkey-patched into +Daru::DataFrame+
+      # @param instance [Class] The Daru-IO class to be linked to monkey-patched function
+      #
+      # @return A `Daru::DataFrame` class method in case of Importer, and instance
+      #   variable method in case of Exporter.
+      def register_io_module(function, instance=nil, &block)
+        return define_singleton_method(function, &block) if block_given?
+
+        case function.to_s
+        when /\Ato_.*_string\Z/, /\Ato_/, /\Awrite_/ then register_exporter(function, instance)
+        when /\Afrom_/, /\Aread_/                    then register_importer(function, instance)
+        else raise ArgumentError, 'Invalid function name given to monkey-patch into Daru::DataFrame.'
+        end
+      end
+
+      private
+
+      def register_exporter(function, instance)
+        define_method(function) do |*args, &io_block|
+          case function.to_s
+          when /\Ato_.*_string\Z/ then instance.new(self, *args, &io_block).to_s
+          when /\Ato_/            then instance.new(self, *args, &io_block).to
+          when /Awrite_/          then instance.new(self, *args[1..-1], &io_block).write(*args[0])
+          end
+        end
+      end
+
+      def register_importer(function, instance)
+        define_singleton_method(function) do |*args, &io_block|
+          case function.to_s
+          when /\Afrom_/ then instance.new.from(*args[0]).call(*args[1..-1], &io_block)
+          when /\Aread_/ then instance.new.read(*args[0]).call(*args[1..-1], &io_block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/daru/io/version.rb

@@ -0,0 +1,5 @@
+module Daru
+  module IO
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,269 @@
+--- !ruby/object:Gem::Specification
+name: daru-io
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Athitya Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: daru
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: |2
+    Daru-IO is a plugin-gem to Daru gem, which stands for Data Analysis in RUby. Daru-IO extends support for many Import and Export methods of Daru::DataFrame. This gem is intended to help Rubyists who are into Data Analysis or Web Development, by serving as a general purpose conversion library,  while also making it incredibly easy to getting started on analyzing data with daru.
+email:
+- athityakumar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rspec_formatter.rb"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- daru-io.gemspec
+- lib/daru/io.rb
+- lib/daru/io/base.rb
+- lib/daru/io/exporters.rb
+- lib/daru/io/exporters/avro.rb
+- lib/daru/io/exporters/base.rb
+- lib/daru/io/exporters/csv.rb
+- lib/daru/io/exporters/excel.rb
+- lib/daru/io/exporters/json.rb
+- lib/daru/io/exporters/r_data.rb
+- lib/daru/io/exporters/rds.rb
+- lib/daru/io/exporters/sql.rb
+- lib/daru/io/importers.rb
+- lib/daru/io/importers/active_record.rb
+- lib/daru/io/importers/avro.rb
+- lib/daru/io/importers/base.rb
+- lib/daru/io/importers/csv.rb
+- lib/daru/io/importers/excel.rb
+- lib/daru/io/importers/excelx.rb
+- lib/daru/io/importers/html.rb
+- lib/daru/io/importers/json.rb
+- lib/daru/io/importers/mongo.rb
+- lib/daru/io/importers/plaintext.rb
+- lib/daru/io/importers/r_data.rb
+- lib/daru/io/importers/rds.rb
+- lib/daru/io/importers/redis.rb
+- lib/daru/io/importers/sql.rb
+- lib/daru/io/link.rb
+- lib/daru/io/version.rb
+homepage: https://github.com/athityakumar/daru-io
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Daru-IO is a plugin-gem to Daru gem, which stands for Data Analysis in RUby.
+test_files: []