labilerecord 0.0.10

data/History.txt

@@ -0,0 +1,22 @@
+== 0.0.9 2009-05-07
+
+* 1 major enhancement:
+  * Initial release
+* 2 :
+  * Bumped version for github
+* 3 :
+  * Changed Query.data to Query.rows
+* 4 :
+  * Access Model[x] instea of Model.rows[x]
+* 5 :
+  * Fixed bug introduced in 0.0.4 always referencing row[0]
+* 6 :
+  * Fix incorrect field.type_id
+* 7 :
+	* Increment revision; minor bug fix
+* 8 :
+	* Added Query.to_insert_sql to transform dataset into
+	an insert statement ... handy for data copies.
+* 9 :
+  * Attempt to load alternate postgresql adapter
+  * Fix readme example typo

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/labilerecord.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_labilerecord.rb

data/PostInstall.txt

@@ -0,0 +1,2 @@
+
+For more information on labilerecord, see http://github.com/adacosta/labilerecord

data/README.rdoc

@@ -0,0 +1,72 @@
+= labilerecord
+
+* http://github.com/adacosta/labilerecord
+
+== DESCRIPTION:
+
+* Simple data access for dynamic data sets through postgres with ruby
+
+== FEATURES:
+
+* Access data by row[x].column
+* Access field types
+* Access types which ActiveRecord won't (e.g. _int4)
+* Easy to use on tables, views, and functions
+* Fast - no ruby type conversion on values from connection adapter
+* Simple sql generation for data copy using Query.to_insert_sql
+
+== SYNOPSIS:
+
+  require 'rubygems'
+  require 'labilerecord'
+  
+  LabileRecord::Base.connection = { :dbname => 'postgres', 
+                                    :user => user, 
+                                    :pass => pass, 
+                                    :host => host, 
+                                    :port => port}
+    
+  databases = LabileRecord::Query.new("SELECT * FROM pg_database")
+  # execute the query
+  databases.exec!
+  # inspect rows
+  puts databases.inspect
+  # inspect fields (columns)
+  puts databases.fields.inspect
+  # inspect specific row and column of data set
+  # datname - being a column returned by the query
+  puts databases[0].datname
+
+== REQUIREMENTS:
+
+* pg gem (gem install pg)
+
+== INSTALL:
+
+  sudo gem sources -a http://gems.github.com
+  sudo gem install adacosta-labilerecord
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Alan Da Costa
+
+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,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/labilerecord'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('labilerecord', LabileRecord::VERSION) do |p|
+  p.developer('Alan Da Costa', 'alandacosta@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/labilerecord.rb

@@ -0,0 +1,144 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module LabileRecord
+  VERSION = '0.0.10'
+
+  begin
+    require 'pg'
+  rescue LoadError
+    begin
+      require 'postgres'
+    rescue LoadError
+      raise LoadError, 'no postgres adapters available to load; ensure rubygems or a postgres connection adapter path is required'
+    end
+  end
+
+  class Base
+    class << self
+      def connection
+        @connection
+      end
+
+      def connection=(*args)
+        @connection = PGconn.open(*args)
+      end
+    end
+  end
+
+  class Query < Array
+    attr_reader :result
+    attr_reader :fields
+    attr_reader :string
+
+    def initialize(query_string)
+      @string = query_string
+    end
+
+    def exec!
+      @result = connection.exec(@string)
+      parse_fields
+      parse_result_data
+      self
+    end
+
+    def parse_result_data
+      columns = @result.fields
+      row_count = @result.num_tuples
+      field_names = @fields.map {|field| field.name}
+      # iterate rows
+      (0..(row_count-1)).each do |row_index|
+        row = Row.new(field_names)
+        columns.each do |column_name|
+          row << @result[row_index][column_name]
+        end
+        send "<<", row
+      end
+    end
+
+    def parse_fields
+      @fields = @field_names = []
+      @result.fields.each_with_index do |field_name, i|
+        pg_field_type_id = @result.ftype(i)
+        type = connection.exec("SELECT typname FROM
+                                pg_type WHERE oid = #{pg_field_type_id}")
+        field_type_name = type[0][type.fields[0]].to_s
+        @fields << Field.new( field_name, field_type_name, pg_field_type_id)
+      end
+    end
+
+    def connection
+      LabileRecord::Base.connection
+    end
+
+    def to_insert_sql(table_name=nil, quote="'")
+      # return: [INSERT INTO table_name] (column_list) VALUES(value_list);
+      sql = ""
+      each do |row|
+        non_nil_column_names = []
+        non_nil_values = []
+        row.each_with_index do |column, i|
+          non_nil_column_names << fields[i].name if !column.nil?
+          non_nil_values << column if !column.nil?
+        end
+        sql += %Q[
+          #{"INSERT INTO " + table_name.to_s if table_name} (#{ non_nil_column_names.map { |c| quote_object(c) } * "," }) VALUES (#{ non_nil_values.map { |c| quote_value(c, quote) } * "," });
+        ].strip + "\n"
+      end
+      sql
+    end
+
+    def to_static_set_sql(quote="'")
+      rows_sql = ""
+      self.each_with_index do |row, row_index|
+        row_sql = "SELECT "
+        self.fields.each_with_index do |field, field_index|
+          row_field_value = row.send(field.name.to_sym)
+          # builds: value + cast as column + [',' if not last row]
+          row_sql << (row_field_value ? quote_value(row_field_value, quote) : "NULL")
+          row_sql << "::" + field.type + %Q[ AS "#{field.name}"]
+          row_sql << ", " if field_index < self.fields.length - 1
+        end
+        row_sql << " UNION\n" if row_index < self.length - 1
+        rows_sql << row_sql
+      end
+      rows_sql
+    end
+
+    private
+
+    def quote_value(string, quote="'")
+      quote + string.to_s + quote
+    end
+
+    def quote_object(string)
+      '"' + string.to_s + '"'
+    end
+  end
+
+  class Field
+    attr_reader :name
+    attr_reader :type
+    attr_reader :type_id
+
+    def initialize(name, type, type_id)
+      @name = name
+      @type = type
+      @type_id = type_id
+    end
+  end
+
+  class Row < Array
+    def initialize(fields)
+      @fields = fields
+    end
+
+    def method_missing(meth, *args)
+      if ( field_index = @fields.index(meth.id2name) )
+        at field_index
+      else
+        super(meth, *args)
+      end
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/labilerecord.rb'}"
+puts "Loading labilerecord gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/labilerecord'

data/test/test_labilerecord.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestLabilerecord < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: labilerecord
+version: !ruby/object:Gem::Version 
+  version: 0.0.10
+platform: ruby
+authors: 
+- Alan Da Costa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: pg
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.0
+    version: 
+description: "* Simple data access for dynamic data sets through postgres with ruby"
+email: 
+- alandacosta@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/labilerecord.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_labilerecord.rb
+has_rdoc: true
+homepage: http://github.com/adacosta/labilerecord
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: labilerecord
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: "* Simple data access for dynamic data sets through postgres with ruby"
+test_files: 
+- test/test_helper.rb
+- test/test_labilerecord.rb