activerecord-utils 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a972ada88d58d419b8cbe37ffd2a8f759ed71317
-  data.tar.gz: 35bbf160a49f76616d701fb52d6aebff58ee4698
+  metadata.gz: 0170989d89e7f272711aa9fb84b0deec2b1c51f3
+  data.tar.gz: d0b7a914857f0a9a8f98a73b8cc93069188fde30
 SHA512:
-  metadata.gz: 85725b37c1121e4c61eb56e9f917408526ce676f19ec3742894bbfa1a89bef5f35fb1e6fda6e101ca77b33559e56d489c88312350e9df36a24828d5e4baef6c9
-  data.tar.gz: b161fed850886f04ae9056cdf28253cf831a1390237c1594c7b7b62ec60527ceeef5c3aebb673aaa30e133ccfe3242576d18404cd614cb1779038e18440ff457
+  metadata.gz: 5589fde05b548766683fbe697cef2ae9850a771aa79d6ea6745e8a29f489edbbab059ef0d09952cd05c0a230c4c3a44a9ace9d4f7422a5f94eb2ffd2e218ad36
+  data.tar.gz: f988280ea2755298f2372db81478307754b4a873df33e2ce9e6a4519808ef2eaca24c333014b1d79d819b8817a7ee2b427e300e1dd310d8c7f3b1f983531fb8f

data/Manifest.txt

@@ -4,10 +4,12 @@ README.md
 Rakefile
 lib/activerecord/utils.rb
 lib/activerecord/utils/alias.rb
+lib/activerecord/utils/browser.rb
 lib/activerecord/utils/comp3.rb
 lib/activerecord/utils/random.rb
 lib/activerecord/utils/version.rb
 test/helper.rb
+test/test_browser.rb
 test/test_finders.rb
 test/test_random.rb
 test/test_readers.rb

data/Rakefile

@@ -3,7 +3,7 @@ require './lib/activerecord/utils/version.rb'
 
 Hoe.spec 'activerecord-utils' do
 
-  self.version = ActiveRecord::Utils::VERSION
+  self.version = ActiveRecordUtils::VERSION
 
   self.summary = 'activerecord-utils - utilities (e.g. random, alias_attr, etc.) for activerecord'
   self.description = summary
@@ -18,7 +18,8 @@ Hoe.spec 'activerecord-utils' do
   self.history_file = 'History.md'
 
   self.extra_deps = [
-    ['logutils']
+    ['logutils'],
+    ['activerecord']
   ]
 
   self.licenses = ['Public Domain']
@@ -28,4 +29,4 @@ Hoe.spec 'activerecord-utils' do
   }
 
 
-end
+end

data/lib/activerecord/utils.rb

@@ -1,10 +1,10 @@
+# encoding: utf-8
 
-require 'activerecord/utils/version'  # let version always go first
 
+require 'activerecord/utils/version'  # let version always go first
 
-module ActiveRecord
 
-module Utils
+module ActiveRecordUtils
 
   def self.banner
     ## add ar PRE too? how?
@@ -16,9 +16,7 @@ module Utils
     "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
   end
 
-end  # module Utils
-
-end  # module ActiveRecord
+end  # module ActiveRecordUtils
 
 
 ########################
@@ -31,9 +29,10 @@ end
 
 require 'activerecord/utils/alias'
 require 'activerecord/utils/random'
+require 'activerecord/utils/browser'
 
 
-puts ActiveRecord::Utils.banner    # say hello
+puts ActiveRecordUtils.banner    # say hello
 
-### puts "root: >#{ActiveRecord::Utils.root}<"   # check root path (remove later)
+### puts "root: >#{ActiveRecordUtils.root}<"   # check root path (remove later)
 

data/lib/activerecord/utils/alias.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 
 module ActiveRecord
 class Base

data/lib/activerecord/utils/browser.rb

@@ -0,0 +1,282 @@
+# encoding: utf-8
+
+module ActiveRecordUtils
+
+####
+# simple (generic) database browser - no models required
+
+
+class Browser  # also (formerly) known as connection manager
+
+  # get connection names
+  #  def connection_names
+  #    ActiveRecord::Base.configurations.keys
+  #  end
+
+  CONNECTS = {}  # cache connections
+
+  def connection_for( key )
+    # cache connections - needed? why? why not??
+
+    #  hack: for now only use cached connection if still active
+    #   if not; get a new one to avoid connection closed errors in rails
+    con = CONNECTS[ key ]
+    if con
+      puts "[Browser] cached connection found; con.active? #{con.active?}"
+      unless con.active?
+        puts "[Browser] *** reset cached connection (reason: connection stale/closed/not active)"
+        con = CONNECTS[ key ] = nil
+      end
+    end
+
+    if con.nil?
+      con = CONNECTS[ key ] =  AbstractModel.connection_for( key )
+    end
+
+    # note: make sure connection is active?
+    #  use verify!  - will try active? followed by reconnect!
+    # - todo: check ourselves if active? - why? why not??
+    #  -- not working w/ rails - after verify! still getting error w/ closed connection
+    # -- con.verify!
+
+    # wrap ActiveRecord connection in our own connection class
+    Connection.new( con, key )
+  end
+
+
+  class AbstractModel < ActiveRecord::Base
+    self.abstract_class = true   # no table; class just used for getting db connection
+
+    def self.connection_for( key )
+      establish_connection( key )
+      connection
+    end
+
+  end # class AbstractModel
+
+
+  class Connection
+
+    def initialize( connection, key )
+      @connection = connection
+      @key        = key
+    end
+
+    attr_reader  :connection
+    attr_reader  :key
+
+    delegate :select_value, :select_all, :adapter_name,
+             :to => :connection
+
+    def class_name
+      @connection.class.name
+    end
+
+  #    delegate :quote_table_name, :quote_column_name, :quote,
+  #             :update, :insert, :delete,
+  #             :add_limit_offset!,
+  #             :to => :connection
+
+    def tables
+      @tables ||= fetch_table_defs
+    end
+
+    def table( name )
+      tables.find { |t| t.name.downcase == name.downcase }
+    end
+
+    # getting list of column definitions
+    # and order them to be more human readable
+    def table_columns( name )
+      cols = fetch_table_column_defs( name )
+      ### fix/to be done
+      # cols.sort_by{|col|
+      #    [
+      #      fields_to_head.index(col.name) || 1e6,
+      #      -(fields_to_tail.index(col.name) || 1e6),
+      #      col.name
+      #    ]
+      #  }
+      cols
+    end
+
+    def fetch_table_defs
+      @connection.tables.sort.map do |name|
+        Table.new( self, name )
+      end
+    end
+
+    def fetch_table_column_defs( name )
+      ### fix/todo: add reference to table_def
+      @connection.columns( name ).map do |col|
+        Column.new( col.name, col.sql_type, col.default, col.null )
+      end
+    end
+
+
+    def fetch_table_select_all( name, opts={} )
+      limit =  (opts[:limit] || 33).to_i # 33 records limit/per page (for now default)
+      limit =  33   if limit == 0   # use default page size if limit 0 (from not a number para)
+      
+      offset = (opts[:offset] || 0).to_i
+
+      sql = "select * from #{name} limit #{limit}"
+
+      sql << " offset #{offset}"   if offset > 0     # add offset if present (e.g greater zero)
+
+      # page = (opts[:page] || 1 ).try(:to_i)
+      # fields = opts[:fields] || nil
+     
+      # rez = { :fields => fields }
+      # if sql =~ /\s*select/i && per_page > 0
+      #  rez[:count] = select_value("select count(*) from (#{sql}) as t").to_i
+      #  rez[:pages] = (rez[:count].to_f / per_page).ceil
+      #  sql = "select * from (#{sql}) as t"
+      #  add_limit_offset!( sql,
+      #                        :limit => per_page,
+      #                        :offset => per_page * (page - 1))
+      # end
+
+      result = {}
+      result[ :sql  ] = sql    # note: lets also always add sql query to result too
+      result[ :rows ] = select_all( sql )
+
+      #    unless rez[:rows].blank?
+      #      rez[:fields] ||= []
+      #      rez[:fields].concat( self.sort_fields(rez[:rows].first.keys) - rez[:fields] )
+      #    end
+
+      Result.new( result )
+    rescue StandardError => ex
+      Result.new( error: ex )
+    end  # fetch_table
+
+
+=begin
+      def column_names(table)
+        columns(table).map{|c| c.name}
+      end
+
+      # fields to see first
+      def fields_to_head
+        @fields_to_head ||= %w{id name login value}
+      end
+
+      # fields to see last
+      def fields_to_tail
+        @fields_to_tail ||= %w{created_at created_on updated_at updated_on}
+      end
+
+      attr_writer :fields_to_head, :fields_to_tail
+
+      # sort field names in a rezult
+      def sort_fields(fields)
+        fields = (fields_to_head & fields) | (fields - fields_to_head)
+        fields = (fields - fields_to_tail) | (fields_to_tail & fields)
+        fields
+      end
+
+      # performs query with appropriate method
+      def query(sql, opts={})
+        per_page = (opts[:perpage] || nil).to_i
+        page = (opts[:page] || 1 ).try(:to_i)
+        fields = opts[:fields] || nil
+        case sql
+        when /\s*select/i , /\s*(update|insert|delete).+returning/im
+          rez = {:fields => fields}
+          if sql =~ /\s*select/i && per_page > 0
+            rez[:count] = select_value("select count(*) from (#{sql}) as t").to_i
+            rez[:pages] = (rez[:count].to_f / per_page).ceil
+            sql = "select * from (#{sql}) as t"
+            add_limit_offset!( sql,
+                              :limit => per_page,
+                              :offset => per_page * (page - 1))
+          end
+
+          rez[:rows] = select_all( sql )
+
+          unless rez[:rows].blank?
+            rez[:fields] ||= []
+            rez[:fields].concat( self.sort_fields(rez[:rows].first.keys) - rez[:fields] )
+          end
+
+          Result.new(rez)
+        when /\s*update/i
+          Result.new :value => update( sql )
+        when /\s*insert/i
+          Result.new :value => insert( sql )
+        when /\s*delete/i
+          Result.new :value => delete( sql )
+        end
+      rescue StandardError => e
+        Result.new :error => e
+      end
+
+=end
+      
+  end # class Connection
+
+
+  class Table
+
+    def initialize(connection, name)
+      @connection = connection
+      @name       = name
+    end
+
+    attr_reader :connection
+    attr_reader :name
+
+    def count
+      @connection.select_value( "select count(*) from #{name}").to_i
+    end
+
+    def columns
+      # load columns on demand for now (cache on first lookup)
+      @columns ||= @connection.table_columns( @name )
+    end
+
+    def query( opts={})
+      @connection.fetch_table_select_all( @name, opts )
+    end
+
+  end # class Table
+
+
+  class Column
+    def initialize(name, type, default, null)
+      @name    = name
+      @type    = type   # note: is sql_type
+      @default = default
+      @null    = null   # note: true|false depending if NOT NULL or not
+    end
+
+    attr_reader :name, :type, :default, :null
+  end # class Column
+
+
+  class Result
+    def initialize( opts={} )
+      @sql = opts[:sql]  # sql statement as a string
+
+      if opts[:error]
+        @error = opts[:error]
+      else
+        @rows = opts[:rows]
+        # @count = opts[:count] || @rows.size
+        # @pages = opts[:pages] || 1
+        # @fields = opts[:fields]
+      end
+    end
+
+    attr_reader :sql, :rows, :error   ### to be done :count, :pages, :fields, 
+
+    def error?()  @error.present?;       end
+    def rows?()   @rows != nil;          end
+  end # class Result
+
+
+end # class Browser
+
+end # module ActiveRecordUtils
+

data/lib/activerecord/utils/comp3.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# encoding: utf-8
 
 module ActiveRecord
 class Base

data/lib/activerecord/utils/random.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# encoding: utf-8
 
 module ActiveRecord
 class Base

data/lib/activerecord/utils/version.rb

@@ -1,9 +1,8 @@
+# encoding: utf-8
 
-module ActiveRecord
+module ActiveRecordUtils
 
-module Utils
-   VERSION = '0.3.0'
-end
+  VERSION = '0.4.0'
 
-end # module ActiveRecord
+end # module ActiveRecordUtils
 

data/test/test_browser.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_browser.rb
+#  or better
+#     rake test
+
+
+require 'helper'
+
+class TestBrowser < MiniTest::Test
+
+  DB_CONFIG = {
+    adapter:  'sqlite3',
+    database: ':memory:'
+  }
+
+  def test_connect
+    
+    browser = ActiveRecordUtils::Browser.new
+
+    ## Note: every connect will create a new empty in memory db
+    ##   check - is it possible to reconnect to in memory db??
+    ##  use (try) key instead of connection-spec ??
+
+    con = browser.connection_for( DB_CONFIG )
+    tables = con.tables
+    
+    pp tables
+
+    assert true   # for now if get here; assume it's working so far
+  end
+
+end # class TestBrowser
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-13 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -68,10 +82,12 @@ files:
 - Rakefile
 - lib/activerecord/utils.rb
 - lib/activerecord/utils/alias.rb
+- lib/activerecord/utils/browser.rb
 - lib/activerecord/utils/comp3.rb
 - lib/activerecord/utils/random.rb
 - lib/activerecord/utils/version.rb
 - test/helper.rb
+- test/test_browser.rb
 - test/test_finders.rb
 - test/test_random.rb
 - test/test_readers.rb
@@ -102,6 +118,7 @@ signing_key:
 specification_version: 4
 summary: activerecord-utils - utilities (e.g. random, alias_attr, etc.) for activerecord
 test_files:
+- test/test_browser.rb
 - test/test_readers.rb
 - test/test_finders.rb
 - test/test_random.rb