table_renamable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 295d31b7d7ae975d082ac5d807465cd1eafad278
+  data.tar.gz: 1af6841d11a014733e54832144587c531a795013
+SHA512:
+  metadata.gz: 83340587d906f332996104c16470cf33f59c41cceeea0297956ba371901e459565132335a23406abf245ac4e554bbdc1f5b232ad4678f95efb9a264001d5215f
+  data.tar.gz: 6e5bc7a75d85aef2fcb27f2d5e0cff43f9fca58ae2bc07fb9209d8ad2bcb7417e3ae015594c1e808e2a9caf2c0637f4eb43d8beeae3932bb6dbf87e3fc2db54d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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/README.rdoc

@@ -0,0 +1,3 @@
+= TableRenamable
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TableRenamable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/table_renamable/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/table_renamable/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/table_renamable/application_controller.rb

@@ -0,0 +1,4 @@
+module TableRenamable
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/table_renamable/application_helper.rb

@@ -0,0 +1,4 @@
+module TableRenamable
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/table_renamable/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TableRenamable</title>
+  <%= stylesheet_link_tag    "table_renamable/application", :media => "all" %>
+  <%= javascript_include_tag "table_renamable/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+TableRenamable::Engine.routes.draw do
+end

data/lib/table_renamable/connection_adapters/mysql2_adapter.rb

@@ -0,0 +1,31 @@
+module TableRenamable
+  module ConnectionAdapters
+    module Mysql2Adapter
+
+      #
+      # Override execute to reload database info
+      # @param  *args [Array<Mixed>] Just here so we can call super
+      #
+      # @return [type] [description]
+      def execute(sql, name = nil)
+        # set up tries so we don't keep retrying
+        tries = 0
+        begin
+          tries += 1
+          # call the actual execut behavior
+          super(sql, name)
+        rescue ActiveRecord::StatementInvalid => e
+          # only try once
+          raise e if tries > 1
+          # re-raise if it's not an error we care about
+          raise e unless e.message =~ /Table.*doesn't exist/
+          # otherwise we reload and retry
+          TableRenamable::Model.reload_tables
+          sql = TableRenamable::Model.process_sql(sql)
+          retry
+        end
+      end
+
+    end
+  end
+end

data/lib/table_renamable/connection_adapters/sqlite3_adapter.rb

@@ -0,0 +1,62 @@
+module TableRenamable
+  module ConnectionAdapters
+    module SQLite3Adapter
+
+      extend ActiveSupport::Concern
+
+      # when we are included we add our behavior
+      self.included do |klass|
+        klass.alias_method_chain(:exec_query, :table_renamable)
+        klass.alias_method_chain(:execute, :table_renamable)
+        klass.alias_method_chain(:table_structure, :table_renamable)
+      end
+
+      def exec_query_with_table_renamable(*args, &block)
+        self.with_retry do
+          self.exec_query_without_table_renamable(*args, &block)
+        end
+      end
+
+      #
+      # Override execute to reload database info
+      # @param  *args [Array<Mixed>] Just here so we can call super
+      #
+      # @return [type] [description]
+      def execute_with_table_renamable(*args, &block)
+        self.with_retry do
+          self.execute_without_table_renamable(*args, &block)
+        end
+      end
+
+      def table_structure_with_table_renamable(table_name)
+        self.with_retry do
+          # get the correct table name to check - otherwise this will fail
+          # on retry
+          current_table_name = TableRenamable::Model.get_current_table_name(
+            table_name
+          )
+          self.table_structure_without_table_renamable(current_table_name)
+        end
+      end
+
+
+      def with_retry(&block)
+        # set up tries so we don't keep retrying
+        tries = 0
+        begin
+          tries += 1
+          # call the actual execute behavior
+          yield
+        rescue ActiveRecord::StatementInvalid => e
+          # only try once
+          raise e if tries > 1
+          # re-raise if it's not an error we care about
+          raise e unless e.message =~ /Could not find table/
+          # otherwise we reload and retry
+          TableRenamable::Model.reload_tables
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/table_renamable/connection_adapters.rb

@@ -0,0 +1,13 @@
+module TableRenamable
+  module ConnectionAdapters
+
+    extend ActiveSupport::Autoload
+
+    autoload :Mysql2Adapter
+    autoload(
+      :SQLite3Adapter,
+      'table_renamable/connection_adapters/sqlite3_adapter'
+    )
+
+  end
+end

data/lib/table_renamable/deprecated_table.rb

@@ -0,0 +1,106 @@
+module TableRenamable
+  #
+  # Class that handles the renaming of tables.  This sets the table name
+  # of the class based on whether or not the table exists in the database
+  #
+  # @author [dlangevin]
+  #
+  class DeprecatedTable
+
+    class NoTableError < Exception; end;
+
+    # @!attribute klass
+    #   @return [Class] The class whose table we are renaming
+    attr_reader :klass
+
+    # @!attribute old_name
+    #   @return [Symbol] The old table name
+    attr_reader :old_name
+
+    # @!attribute new_name
+    #   @return [Symbol] The new table name
+    attr_reader :new_name
+
+    #
+    # Constructor - sets up the record and tries to connect to
+    # the correct database
+    #
+    # @param  klass [Class] Class whose table we are renaming
+    # @param  old_name [String, Symbol] The old table name
+    # @param  new_name [String, Symbol] The new table name
+    #
+    def initialize(klass, old_name, new_name)
+      @klass = klass
+      @old_name = old_name
+      @new_name = new_name
+      # call to set the correct table name
+      self.set_table_name
+    end
+
+    #
+    # Returns the name of the table that currently exists of our
+    # two options (old or new)
+    #
+    # @return [String] The name of the existing table
+    def get_current_table_name
+      [self.old_name, self.new_name].each do |name|
+        return name.to_s if self.table_exists?(name)
+      end
+      # raise exception if we don't have a valid table
+      self.raise_no_table_error
+    end
+
+    #
+    # Is this table name part of our DeprecatedTable definition
+    # @param  table_name [String, Symbol] Table name to chck
+    #
+    # @return [Boolean] Whether or not we have it in our definition
+    def has_table?(table_name)
+      [self.old_name, self.new_name].include?(table_name.to_sym)
+    end
+
+    #
+    # Set the correct table name for the Class we are controlling
+    #
+    # @raise [TableRenamable::NoTableError] Error if neither name works
+    #
+    # @return [Boolean] True if we set the table name
+    def set_table_name
+      [self.old_name, self.new_name].each do |name|
+        # make sure this table exists
+        if self.table_exists?(name)
+          # return true if we are already using this table
+          return true if self.klass.table_name == name.to_s
+          # otherwise we can change the table name
+          self.klass.table_name = name
+          return true
+        end
+      end
+      self.raise_no_table_error
+    end
+
+    protected
+
+    #
+    # Wrapper to raise an error
+    #
+    # @raise [DeprecatedTable::NoTableError]
+    def raise_no_table_error
+      raise NoTableError.new(
+        "No table for #{self.klass}.  " +
+        "Tried #{self.old_name} and #{self.new_name}"
+      )
+    end
+
+    #
+    # Does a given table exist?
+    # @param  name [String, Symbol] Table name
+    #
+    # @return [Boolean] Whether or not it exists
+    def table_exists?(name)
+      self.klass.connection.tables.include?(name.to_s)
+    end
+
+
+  end
+end

data/lib/table_renamable/engine.rb

@@ -0,0 +1,22 @@
+module TableRenamable
+  class Engine < ::Rails::Engine
+    isolate_namespace TableRenamable
+
+    config.after_initialize do
+      # set up our reload behavior for when table names change for MySQL
+      if defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+        ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(
+          :include,
+          TableRenamable::ConnectionAdapters::Mysql2Adapter
+        )
+      # same thing for SQLite
+      elsif defined?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
+        ActiveRecord::ConnectionAdapters::SQLite3Adapter.send(
+          :include,
+          TableRenamable::ConnectionAdapters::SQLite3Adapter
+        )
+      end
+    end
+
+  end
+end

data/lib/table_renamable/model.rb

@@ -0,0 +1,95 @@
+module TableRenamable
+  #
+  # Model that is included in ActiveRecord to enable our behavior
+  #
+  # @author [dlangevin]
+  #
+  module Model
+
+    extend ActiveSupport::Concern
+
+    class NoTableError < Exception; end;
+
+
+    included do |klass|
+      klass.class_attribute :deprecated_columns
+      klass.deprecated_columns = []
+    end
+
+
+    #
+    # Return our list of deprecated tables
+    #
+    # @return [Array<DeprecatedTable>] Our list of deprecated tables
+    def self.deprecated_tables
+      @deprecated_tables ||= []
+    end
+
+    #
+    # Update a string of SQL to replace deprecated tables
+    # @param  sql [String] SQL TO update
+    #
+    # @return [String] Updated SQL
+    def self.process_sql(sql)
+      self.deprecated_tables.each do |deprecated_table|
+        # our current table name
+        current_table_name = deprecated_table.get_current_table_name
+        old_table_name = deprecated_table.old_name
+        sql = sql.gsub(/#{old_table_name}/, current_table_name.to_s)
+      end
+      sql
+    end
+
+    #
+    # Reload our table names so we pick up any changes
+    #
+    # @return [Boolean] Always true
+    def self.reload_tables
+      self.deprecated_tables.each(&:set_table_name)
+      true
+    end
+
+    #
+    # ClassMethods to be mixed in to the model using this behavior
+    #
+    # @author [dlangevin]
+    #
+    module ClassMethods
+
+      #
+      # Overrides columns to remove deprecated columns
+      #
+      # @return [Array<>] Filtered array of columns
+      def columns
+        super.reject { |column|
+          self.deprecated_columns.include?(column.name)
+        }
+      end
+
+      #
+      # Mark columns as deprecated
+      # @param  *column_names [Array<String, Symbol>] Column names
+      #
+      # @return [Array<String>] List of deprecated columns
+      def deprecate_columns(*column_names)
+        self.deprecated_columns =
+          self.deprecated_columns + Array.wrap(column_names).collect(&:to_s)
+      end
+
+      #
+      # Mark this class as having a potentially new table name
+      # @param  old_name [String, Symbol] The old table name
+      # @param  new_name [String, Symbol] The new table name
+      #
+      # @return [TableRenamable::DeprecatedTable] The newly
+      # created TableRenamable::DeprecatedTable records
+      def deprecate_table_name(old_name, new_name)
+        deprecated_table = DeprecatedTable.new(self, old_name, new_name)
+        TableRenamable::Model.deprecated_tables << deprecated_table
+        deprecated_table
+      end
+
+    end
+
+  end
+end

data/lib/table_renamable/version.rb

@@ -0,0 +1,3 @@
+module TableRenamable
+  VERSION = "0.0.1"
+end

data/lib/table_renamable.rb

@@ -0,0 +1,11 @@
+require "table_renamable/engine"
+
+module TableRenamable
+
+  extend ActiveSupport::Autoload
+
+  autoload :ConnectionAdapters
+  autoload :DeprecatedTable
+  autoload :Model
+
+end

data/lib/tasks/table_renamable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :table_renamable do
+#   # Task goes here
+# end