mydbi 1.0.5

data/History.txt

@@ -0,0 +1,12 @@
+=== 1.0.0 / 2008-01-01
+
+* 1 major enhancement
+
+  * Birthday!
+
+=== 1.0.5 / 2009-11-19
+
+* 1 minor enhancement:
+
+  * Made public.
+

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/mydbi.rb

data/README.txt

@@ -0,0 +1,114 @@
+= mydbi
+
+http://github.com/andynu/mydbi
+
+== DESCRIPTION:
+
+  A simple wrapper for dbi that provides two simple functions dbconnect(profile) and query(sql),
+  along with auth profiles via a configuration file.
+
+== FEATURES/PROBLEMS:
+
+* PROBLEM: no tests => I have some, but they point at local databases and I have not gotten around to making nice mocky ones.
+
+== SYNOPSIS:
+
+DISCLAMER: The DBI api is fine and in most contexts should be used directly.
+I wrote it as a little helper for the hundreds of tiny csv outputers,
+backfills, and other assorted one-off sys-admin data munghing scripts scripts
+that I write. This script intoduces three methods into the Object namespace, it
+should not be used in a larger project. Please keep that in mind.
+
+A simple wrapper for dbi that provides two simple functions:
+
+  dbconnect(dbname="test", host="localhost", user="root", pass="")
+  dbconnect(profile_key)
+
+uses my most common defaults
+
+  query(sql, *values)
+
+which returns the last_insert_id() for auto increment table inserts
+and yields row when selecting.
+
+  ascii_query(sql, *values)
+
+select query output much like mysql's commandline client
+
+== Config file $HOME/.mydbirc
+
+A yaml configuration file for named database connections
+
+  ---
+  :databaseone:
+    :name: db_one
+    :host: localhost
+    :username: root
+    :password:
+  :databasetwo:
+    :name: db_two
+    :host: other_host
+    :username: root
+    :password: secret
+
+Then you can pass the symbol is as the db name
+
+  db1 = dbconnect(:databaseone)
+
+  db2 = dbconnect(:databasetwo)
+
+== Example:
+
+  require 'mydbi'
+
+  dbconnect(:databaseone)
+
+  lastn_id = query("insert into lastn (id, ord, song_id) values (null, 1, 10)");
+  
+  query("select * from lastn") do |row|
+    puts row.inspect
+  end
+
+== Resources
+
+* http://ruby-dbi.rubyforge.org/
+* http://www.kitebird.com/articles/ruby-dbi.html
+
+== REQUIREMENTS:
+
+* dbi
+* dbd-mysql
+* yamlrc
+
+== INSTALL:
+
+(if you haven't already)
+> sudo gem install gem_cutter
+> gem tumble
+
+> sudo gem install mydbi
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Andrew Nutter-Upham
+
+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/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'mydbi' do
+  developer "Andrew Nutter-Upham","andynu+mydbi@gmail.com"
+  extra_deps << ['dbi']
+  extra_deps << ['dbd-mysql']
+  extra_deps << ['yamlrc']
+end
+
+# vim: syntax=ruby

data/lib/mydbi.rb

@@ -0,0 +1,170 @@
+#!/usr/bin/env ruby
+#
+# A simplified dbi api that uses defaults.
+#
+# It isn't that the dbi syntax is difficult or too verbose
+# but the patterns of getting the last_insert_id for inserts,
+# the number of rows modified for updates, and looping over
+# the rows from a select are so common that having a single
+# shorthand, one that can use default to my local database
+# connection is handy.
+#
+require 'dbi'
+require 'yamlrc'
+
+class Mydbi
+  VERSION = "1.0.5"
+end
+
+$mydbi_db = nil;
+
+$mydbi_config = {
+  :default => {
+    :name => '',
+    :host => 'localhost',
+    :username => 'root',
+    :password => ''
+  }
+}.merge(Yamlrc.load(".mydbirc"))
+
+# make a connection, returns the dbh
+#
+# the top level query and ascii_query commands will work with
+# the most recent dbconnection. but if you save the DatabaseHandle
+# returned you can still use those methods off of that object.
+#
+# @db = dbconnect
+# @db.query("whatever")
+#
+def dbconnect(db=nil, host=nil, username=nil, password=nil)
+  config = $mydbi_config[:default] 
+
+  # optionally reset the config to a named datasource
+  if db.instance_of?(Symbol)
+    if $mydbi_config.key?(db)
+      config = $mydbi_config[db] 
+      db = nil
+    else
+      throw ArgumentError.new("No database connection named ':#{db}' is configured")
+    end
+  end
+
+  db =   config[:db] if db.nil?
+  host = config[:host] if host.nil?
+  username = config[:username] if username.nil?
+  password = config[:password] if password.nil?
+
+  $mydbi_db = DBI.connect("DBI:Mysql:#{db}:#{host}", username, password)
+end
+
+# see DBI::DatabaseHandle's query
+def query(sql,*values)
+  return $mydbi_db.query(sql,*values) # TODO this is not passing the block along properly
+end
+
+# see DBI::DatabaseHandle's ascii_query
+def ascii_query(sql,*values)
+  return $mydbi_db.ascii_query(sql,*values)
+end
+
+module DBI
+  class DatabaseHandle
+
+    # execute a query
+    #
+    # SELECT:
+    #
+    # Either the StatementHandle (sth) is returned or if you
+    # pass it a block it will iterate across the results
+    # yielding the row
+    #
+    #   sth = query("select * from songs")
+    #   puts sth.rows
+    #   while( row = sth.fetch )
+    #     p row
+    #   end
+    #   sth.finish
+    #
+    # or
+    #
+    #   query("select * from songs") do |row|
+    #     p row
+    #   end
+    #
+    # INSERT:
+    #
+    # Will return the last_insert_id. Warning! If you provide a bulk insert you'll only
+    # see get back the id of the first insert (with Mysql 5.0.45-Debian_1ubuntu3-log anyway).
+    #
+    #   last_insert_id = query("insert into songs values (?,?,?,?)",nil,artist,album,song)
+    #   => 1
+    #
+    #   last_insert_id = query("insert into songs values (?,?,?,?)",nil,artist,album,song)
+    #   => 2
+    #
+    #
+    # UPDATE:
+    #
+    # Will return the affected_rows_count
+    #
+    #   affected_row_count = query("update songs set artist=? where song_id = ?",new_artist, song_id)
+    #   => 1
+    #
+    # default:
+    #
+    # returns sth after preparing and executing
+    def query(sql,*values)
+      case sql
+      when /^\s*select/i
+        sth = self.prepare(sql)
+        sth.execute(*values)
+        if block_given?
+          while row = sth.fetch do
+            yield(row)
+          end
+          sth.finish
+        else
+          return sth
+        end
+
+      when /^\s*update/i
+        return self.do(sql,*values); # returns affected_rows_count
+      
+      when /^\s*insert/i
+        # automatically getting the last_insert id is really only meant
+        # to work when inserting a single record. bulk inserts ?!
+        rows_inserted = self.do(sql,*values);
+        last_id = nil
+        sql.squeeze(" ").match(/insert into ([^ ]*) /) # grab the table
+        query("select last_insert_id() from #{$1} limit 1"){|row|
+          last_id = row[0];
+        }
+        return last_id
+
+      else # create, drop, truncate, show, ...
+        sth = self.prepare(sql)
+        sth.execute(*values)
+        return sth
+
+      end
+    end
+
+    # prints the query results (columns names and values)
+    # much like the mysql commandline
+    #
+    #   +----+---------+---------------------+
+    #   | id | song_id | played_at           |
+    #   +----+---------+---------------------+
+    #   | 3  | 713     | 2007-12-01 00:44:44 |
+    #   | 4  | 174     | 2007-12-01 00:44:44 |
+    #   +----+---------+---------------------+
+    def ascii_query(sql,*values)
+      sth = self.query(sql,*values)
+      rows = sth.fetch_all
+      col_names = sth.column_names
+      sth.finish
+      DBI::Utils::TableFormatter.ascii(col_names, rows)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: mydbi
+version: !ruby/object:Gem::Version 
+  version: 1.0.5
+platform: ruby
+authors: 
+- Andrew Nutter-Upham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-19 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dbi
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dbd-mysql
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yamlrc
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: |-
+  A simple wrapper for dbi that provides two simple functions dbconnect(profile) and query(sql),
+    along with auth profiles via a configuration file.
+email: 
+- andynu+mydbi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/mydbi.rb
+has_rdoc: true
+homepage: http://github.com/andynu/mydbi
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: mydbi
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for dbi that provides two simple functions dbconnect(profile) and query(sql), along with auth profiles via a configuration file.
+test_files: []
+