purview 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 857247110c4fa3aeb219d07aa207bc4b7017a3d0
-  data.tar.gz: 1348881a82f7aa07d31fbf52ead8423c2d7458eb
+  metadata.gz: 4bfebf90c2dfbac7b718635c204d78fb6921a779
+  data.tar.gz: 7b2da04835cbf716b784300140e02b78d2188aa9
 SHA512:
-  metadata.gz: f77a3dd4d4bab8da4beadd7e2ab4f843e5ad9a5f0e87e66912b055dfa87f2d4237926829fe1658188f7aa6ec486a51fd13c71ef125c5049771066287eeeeb134
-  data.tar.gz: 2d522937e113acd589b83f4d0a0d939f136e461b1620b2181e522d8cfc9d501515865601c2677a8f337e6e21bee9ee0040a612c31c23b1144b28a382451f80bc
+  metadata.gz: 5ec0e4d36ea4d42dd29c3d8bf1608c6c30db990ecc4e95b0fc6ddf7c951db243f2225b5a7be117f2f11597a7467cfada79f8b90073de2c5c13c60a6ce79932d8
+  data.tar.gz: d43914f1565f2f3a6c4ec41245a4e06e00069c521fb9e892f378500640e16c6e277bc5c93595c95d98d4da34751c97e01afaf3f6e7b28390ab60d610a087b888

data/CHANGELOG

@@ -1,36 +1,41 @@
-Release 1.3.0
--------------
+Release 1.3.1 (2015-06-05)
+--------------------------
+
+* Add `table_metadata` helper to `Database` class
+
+Release 1.3.0 (2015-06-04)
+--------------------------
 
 * Add support for easily adding additional indices + clean-up
 * DEPRECATION: `create_temporary_table` deprecated in favor of `create_table`
   with the `temporary` option specified
 
-Release 1.2.0
--------------
+Release 1.2.0 (2015-06-03)
+--------------------------
 
 * Use system-time as opposed to assuming/forcing UTC time
 * Add `sync_table` helper to `Database` class
 * Eliminate explicit `return(s)` -- they were causing issues w/ `yield`
 
-Release 1.1.1
--------------
+Release 1.1.1 (2015-06-02)
+--------------------------
 
 * Add `baseline_table` helper to `Database` class
 
-Release 1.1.0
--------------
+Release 1.1.0 (2015-06-01)
+--------------------------
 
 * Change how `starting_timestamp` is configured
 * BUGFIX: Fix/standardize exception class/file names
 
-Release 1.0.1
--------------
+Release 1.0.1 (2015-05-29)
+--------------------------
 
 * Use consistent naming for database connection-opts (this allowed some DRYing)
 * OPPREF: Only update `table_metadata` when creating/dropping tables
 
-Release 1.0.0
--------------
+Release 1.0.0 (2015-05-28)
+--------------------------
 
 * Support on JRuby, MRI, and RBX for pulling, validating, parsing and loading
   CSV/TSV and SQL data (ETL)

data/TODO

@@ -55,15 +55,17 @@
 
 * Add COPY `def copy(sql)` support to PostgreSQL connection
 * Leverage COPY support for PostgreSQL pulls
-* Create class to encapulate `table_metadata` logic
-* Further encapsulate `Dialect` logic
+* Create class to encapulate `table_metadata` (in order to clean up the logic
+  in the `Database` and `TableMetadata` (struct) classes)
+* Further encapsulate `Dialect` logic (in order to DRY `Database` classes)
+
 * Build out change-log tables
 * Build out canonical, fact and aggregate tables (and related transforms)
 * Configurable re-pull window (do this automatically once up to current?)
 * Add schema management capabilities (detect schema-deltas and suggestion
   modifications)
-* Refactor mutator methods to be globally available (e.g. coalesced -> Coalesce,
-  quoted -> Quote, etc.)
+* Consider refactoring mutator methods to be globally available (e.g. coalesced
+  -> Coalesce, quoted -> Quote, etc.)
 
 ... CLOSED QUESTIONS ...
 

data/lib/purview/databases/base.rb

@@ -207,6 +207,21 @@ module Purview
         table_name
       end
 
+      def table_metadata(table)
+        ensure_table_valid_for_database(table)
+        table_metadata = nil
+        table_name = table_name(table)
+        with_context_logging("`table_metadata` for: #{table_name}") do
+          with_new_connection do |connection|
+            row = connection.execute(table_metadata_sql(table)).rows.first
+            raise Purview::Exceptions::CouldNotFindTableMetadata.new(table) \
+              unless row
+            table_metadata = Purview::Structs::TableMetadata.new(row)
+          end
+        end
+        table_metadata
+      end
+
       def unlock_table(table)
         ensure_table_valid_for_database(table)
         table_name = table_name(table)
@@ -576,53 +591,96 @@ module Purview
         end
       end
 
-      def table_unlocked?(table)
-        !table_locked?(table)
+      def table_metadata_column_definitions
+        [
+          table_metadata_table_name_column_definition,
+          table_metadata_enabled_at_column_definition,
+          table_metadata_last_pulled_at_column_definition,
+          table_metadata_locked_at_column_definition,
+          table_metadata_max_timestamp_pulled_column_definition,
+        ]
+      end
+
+      def table_metadata_column_names
+        table_metadata_columns.map(&:name)
+      end
+
+      def table_metadata_columns
+        [
+          table_metadata_table_name_column,
+          table_metadata_enabled_at_column,
+          table_metadata_last_pulled_at_column,
+          table_metadata_locked_at_column,
+          table_metadata_max_timestamp_pulled_column,
+        ]
+      end
+
+      def table_metadata_enabled_at_column
+        Purview::Columns::Timestamp.new(table_metadata_enabled_at_column_name)
       end
 
       def table_metadata_enabled_at_column_definition
-        column = Purview::Columns::Timestamp.new(table_metadata_enabled_at_column_name)
-        column_definition(column)
+        column_definition(table_metadata_enabled_at_column)
       end
 
       def table_metadata_enabled_at_column_name
         'enabled_at'
       end
 
+      def table_metadata_last_pulled_at_column
+        Purview::Columns::Timestamp.new(table_metadata_last_pulled_at_column_name)
+      end
+
       def table_metadata_last_pulled_at_column_definition
-        column = Purview::Columns::Timestamp.new(table_metadata_last_pulled_at_column_name)
-        column_definition(column)
+        column_definition(table_metadata_last_pulled_at_column)
       end
 
       def table_metadata_last_pulled_at_column_name
         'last_pulled_at'
       end
 
+      def table_metadata_locked_at_column
+        Purview::Columns::Timestamp.new(table_metadata_locked_at_column_name)
+      end
+
       def table_metadata_locked_at_column_definition
-        column = Purview::Columns::Timestamp.new(table_metadata_locked_at_column_name)
-        column_definition(column)
+        column_definition(table_metadata_locked_at_column)
       end
 
       def table_metadata_locked_at_column_name
         'locked_at'
       end
 
+      def table_metadata_max_timestamp_pulled_column
+        Purview::Columns::Timestamp.new(table_metadata_max_timestamp_pulled_column_name)
+      end
+
       def table_metadata_max_timestamp_pulled_column_definition
-        column = Purview::Columns::Timestamp.new(table_metadata_max_timestamp_pulled_column_name)
-        column_definition(column)
+        column_definition(table_metadata_max_timestamp_pulled_column)
       end
 
       def table_metadata_max_timestamp_pulled_column_name
         'max_timestamp_pulled'
       end
 
+      def table_metadata_sql(table)
+        raise %{All "#{Base}(s)" must override the "table_metadata_sql" method}
+      end
+
       def table_metadata_table_name
         'table_metadata'
       end
 
+      def table_metadata_table_name_column
+        Purview::Columns::Id.new(
+          table_metadata_table_name_column_name,
+          :type => Purview::Types::String,
+          :limit => 255,
+        )
+      end
+
       def table_metadata_table_name_column_definition
-        column = Purview::Columns::String.new(table_metadata_table_name_column_name)
-        column_definition(column)
+        column_definition(table_metadata_table_name_column)
       end
 
       def table_metadata_table_name_column_name
@@ -633,6 +691,10 @@ module Purview
         table_opts[:name] || table.name
       end
 
+      def table_unlocked?(table)
+        !table_locked?(table)
+      end
+
       def tables_by_name
         @tables_by_name ||= {}.tap do |result|
           tables.each do |table|

data/lib/purview/databases/mysql.rb

@@ -88,13 +88,9 @@ module Purview
       end
 
       def ensure_table_metadata_table_exists_sql
-        'CREATE TABLE IF NOT EXISTS %s (%s PRIMARY KEY, %s, %s, %s, %s)' % [
+        'CREATE TABLE IF NOT EXISTS %s (%s)' % [
           table_metadata_table_name,
-          table_metadata_table_name_column_definition,
-          table_metadata_enabled_at_column_definition,
-          table_metadata_last_pulled_at_column_definition,
-          table_metadata_locked_at_column_definition,
-          table_metadata_max_timestamp_pulled_column_definition,
+          table_metadata_column_definitions.join(', '),
         ]
       end
 
@@ -212,6 +208,15 @@ module Purview
         ]
       end
 
+      def table_metadata_sql(table)
+        'SELECT %s FROM %s WHERE %s = %s' % [
+          table_metadata_column_names.join(', '),
+          table_metadata_table_name,
+          table_metadata_table_name_column_name,
+          quoted(table.name),
+        ]
+      end
+
       def type_map
         super.merge(
           Purview::Types::Money => 'decimal',

data/lib/purview/databases/postgresql.rb

@@ -88,13 +88,9 @@ module Purview
       end
 
       def ensure_table_metadata_table_exists_sql
-        'CREATE TABLE IF NOT EXISTS %s (%s PRIMARY KEY, %s, %s, %s, %s)' % [
+        'CREATE TABLE IF NOT EXISTS %s (%s)' % [
           table_metadata_table_name,
-          table_metadata_table_name_column_definition,
-          table_metadata_enabled_at_column_definition,
-          table_metadata_last_pulled_at_column_definition,
-          table_metadata_locked_at_column_definition,
-          table_metadata_max_timestamp_pulled_column_definition,
+          table_metadata_column_definitions.join(', '),
         ]
       end
 
@@ -215,6 +211,15 @@ module Purview
         ]
       end
 
+      def table_metadata_sql(table)
+        'SELECT %s FROM %s WHERE %s = %s' % [
+          table_metadata_column_names.join(', '),
+          table_metadata_table_name,
+          table_metadata_table_name_column_name,
+          quoted(table.name),
+        ]
+      end
+
       def type_map
         super.merge(
           Purview::Types::Money => 'money',

data/lib/purview/exceptions/could_not_find_table_metadata.rb

@@ -0,0 +1,9 @@
+module Purview
+  module Exceptions
+    class CouldNotFindTableMetadata < BaseTable
+      def message
+        "Could not find metadata for table: #{table.name}"
+      end
+    end
+  end
+end

data/lib/purview/exceptions.rb

@@ -4,6 +4,7 @@ require 'purview/exceptions/base_table'
 require 'purview/exceptions/could_not_baseline'
 require 'purview/exceptions/could_not_disable'
 require 'purview/exceptions/could_not_enable'
+require 'purview/exceptions/could_not_find_table_metadata'
 require 'purview/exceptions/could_not_initialize'
 require 'purview/exceptions/could_not_lock'
 require 'purview/exceptions/could_not_sync'

data/lib/purview/structs/table_metadata.rb

@@ -0,0 +1,39 @@
+module Purview
+  module Structs
+    class TableMetadata < Base
+      def initialize(row)
+        enabled_at = row.enabled_at && Time.parse(row.enabled_at)
+        last_pulled_at = row.last_pulled_at && Time.parse(row.last_pulled_at)
+        locked_at = row.locked_at && Time.parse(row.locked_at)
+        max_timestamp_pulled = row.max_timestamp_pulled && Time.parse(row.max_timestamp_pulled)
+        super(
+          :table_name => row.table_name,
+          :enabled_at => enabled_at,
+          :last_pulled_at => last_pulled_at,
+          :locked_at => locked_at,
+          :max_timestamp_pulled => max_timestamp_pulled,
+        )
+      end
+
+      def diabled?
+        !enabled?
+      end
+
+      def enabled?
+        !!enabled_at
+      end
+
+      def initialized?
+        !!max_timestamp_pulled
+      end
+
+      def locked?
+        !!locked_at
+      end
+
+      def unlocked?
+        !locked?
+      end
+    end
+  end
+end

data/lib/purview/structs.rb

@@ -2,4 +2,5 @@ require 'purview/structs/base'
 
 require 'purview/structs/result'
 require 'purview/structs/row'
+require 'purview/structs/table_metadata'
 require 'purview/structs/window'

data/lib/purview/version.rb

@@ -1,3 +1,3 @@
 module Purview
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purview
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Jonathan W. Zaleski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/purview/exceptions/could_not_baseline.rb
 - lib/purview/exceptions/could_not_disable.rb
 - lib/purview/exceptions/could_not_enable.rb
+- lib/purview/exceptions/could_not_find_table_metadata.rb
 - lib/purview/exceptions/could_not_initialize.rb
 - lib/purview/exceptions/could_not_lock.rb
 - lib/purview/exceptions/could_not_sync.rb
@@ -167,6 +168,7 @@ files:
 - lib/purview/structs/base.rb
 - lib/purview/structs/result.rb
 - lib/purview/structs/row.rb
+- lib/purview/structs/table_metadata.rb
 - lib/purview/structs/window.rb
 - lib/purview/tables.rb
 - lib/purview/tables/base.rb