activerecord-mysql2legacydb-adapter 0.2.0

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,45 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# netbeans non-shared
+nbproject/private
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "mysql2", "~> 0.2.4"
+gem "activerecord", "~> 3.0.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.0.0.beta.19"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre3"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.5.0.pre3)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mysql2 (0.2.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.0.pre3)
+  mysql2 (~> 0.2.4)
+  rcov
+  rspec (>= 2.0.0.beta.19)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Anders Johannsen
+
+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,17 @@
+= activerecord-mysql2legacydb-adapter
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Anders Johannsen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "activerecord-mysql2legacydb-adapter"
+  gem.name = "activerecord-mysql2legacydb-adapter"
+  gem.summary = %Q{Translates table and field names of legacy databases}
+  gem.description = %Q{If you are stuck with a MySQL database where the naming is, well, unrailslike,
+    activerecord-mysql2-legacy-db-adapter offers a way to do the translation. It works at the driver level and doesn't
+    require you ro change the structure of the database. Also there are no database views which should be kept up to date
+    as you add or remove fields.
+  }
+  gem.email = "anders@johannsen.com"
+  gem.homepage = "http://github.com/andersjo/activerecord-mysql2legacydb-adapter"
+  gem.authors = ["Anders Johannsen"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  spec.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  spec.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency "mysql2", ">= 0.2.4"
+  gem.add_development_dependency "rspec", ">= 2.0.0.beta.19"
+  gem.add_development_dependency "bundler", "~> 1.0.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.0.pre3"
+  gem.add_development_dependency "rcov", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activerecord-mysql2legacydb-adapter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/active_record/connection_adapters/mysql2legacydb_adapter.rb

@@ -0,0 +1,61 @@
+
+module ActiveRecord
+  class Base
+    # same as "def.self.mysql2_connection(config)" in mysql2 gem
+    # except that the ConnectionAdapter returned is a Mysql2LegacyAdapter
+    # instead of a regular Mysql2Adapter
+    def self.mysql2legacydb_connection(config)
+      config[:username] = 'root' if config[:username].nil?
+
+      if Mysql2::Client.const_defined? :FOUND_ROWS
+        config[:flags] = Mysql2::Client::FOUND_ROWS
+      end
+
+      client = Mysql2::Client.new(config.symbolize_keys)
+      options = [config[:host], config[:username], config[:password], config[:database], config[:port], config[:socket], 0]
+      ConnectionAdapters::Mysql2LegacyDBAdapter.new(client, logger, options, config)
+    end
+  end
+
+  module ConnectionAdapters
+    class Mysql2LegacyDBAdapter < Mysql2Adapter
+      delegate :legacy_to_new, :new_to_legacy, :to => :"Mysql2legacydb::DefaultTranslator.new"
+
+      def columns(table_name, name = nil)
+        sql = "SHOW FIELDS FROM #{quote_table_name(table_name)}"
+        columns = []
+        result = execute(sql, :skip_logging)
+        result.each(:symbolize_keys => true, :as => :hash) { |field|
+          columns << Mysql2Column.new(legacy_to_new(field[:Field]), field[:Default], field[:Type], field[:Null] == "YES")
+        }
+        columns
+      end
+
+      def tables_with_translation
+        tables_without_translation.map {|table| legacy_to_new(table) }
+      end
+      alias_method_chain :tables, :translation
+
+      def quote_column_name_with_translation(name)
+        quote_column_name_without_translation(new_to_legacy(name))
+      end
+      alias_method_chain :quote_column_name, :translation
+
+      def quote_table_name_with_translation(name)
+        quote_table_name_without_translation(new_to_legacy(name))
+      end
+      alias_method_chain :quote_table_name, :translation
+
+      def select_with_translation(sql, name = nil)
+        select_without_translation(sql, name).collect { |row|
+          translated = {}
+          row.each { |key,val|
+            translated[legacy_to_new(key)] = val
+          }
+          translated
+        }
+      end
+      alias_method_chain :select, :translation
+    end
+  end
+end

data/lib/activerecord-mysql2legacydb-adapter.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'mysql2legacydb/default_translator'
+require 'mysql2' unless defined? Mysql2
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'

data/lib/mysql2legacydb/default_translator.rb

@@ -0,0 +1,12 @@
+module Mysql2legacydb
+  class DefaultTranslator
+    def legacy_to_new(legacy_name)
+      legacy_name.underscore
+    end
+
+    def new_to_legacy(new_name)
+      new_name.to_s.camelize(:lower)
+    end
+
+  end
+end

data/nbproject/project.properties

@@ -0,0 +1,7 @@
+file.reference.activerecord-mysql2legacydb-adapter-lib=lib
+file.reference.activerecord-mysql2legacydb-adapter-spec=spec
+main.file=
+platform.active=Ruby_0
+source.encoding=UTF-8
+src.dir=${file.reference.activerecord-mysql2legacydb-adapter-lib}
+test.src.dir=${file.reference.activerecord-mysql2legacydb-adapter-spec}

data/nbproject/project.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>activerecord-mysql2legacydb-adapter</name>
+            <source-roots>
+                <root id="src.dir"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.src.dir"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/activerecord-mysql2legacydb-adapter_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+
+describe ActiveRecord::Base do
+  context "'mysql2' adapter" do
+    before do
+      ActiveRecord::Base.establish_connection(TEST_CONFIG.merge({:adapter => 'mysql2'}))
+    end
+
+    it "should return a normal db connection" do
+      ActiveRecord::Base.connection.should be_an_instance_of(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+    end
+  end
+
+  context "'mysql2legacydb' adapter" do
+    before do
+      ActiveRecord::Base.establish_connection(TEST_CONFIG.merge({:adapter => 'mysql2legacydb'}))
+    end
+
+    it "should return a legacy db connection" do
+      ActiveRecord::Base.connection.should be_an_instance_of(ActiveRecord::ConnectionAdapters::Mysql2LegacyDBAdapter)
+    end
+
+  end
+end
+
+describe "ActiveRecord::ConnectionAdapters::Mysql2LegacyDBAdapter" do
+  context "using connection" do
+    it "returns altered table names" do
+      conn = River.connection
+      conn.stub!(:execute).and_return [["WildRivers"]]
+      conn.tables.first.should == "wild_rivers"
+    end
+  end
+
+  context "in ActiveRecord class" do
+    before do
+      VeryLongRiver.establish_connection(TEST_CONFIG.merge({:adapter => 'mysql2legacydb'}))
+      River.establish_connection(TEST_CONFIG.merge({:adapter => 'mysql2legacydb'}))
+    end
+
+    it "should have altered column names" do
+      River.column_names.should == ["name", "total_length_in_km", "total_length_in_miles"]
+    end
+
+    it "should have altered table names" do
+      River.table_name.should == "rivers"
+      VeryLongRiver.table_name.should == "very_long_rivers"
+    end
+
+  end
+
+  context "in ActiveRecord instance" do
+    before do
+      @nile = River.where(:name => "Nile").first
+    end
+
+    it "should map altered column names" do
+      @nile.total_length_in_miles.should == 4132
+    end
+
+  end
+end
+
+TEST_CONFIG = {
+  :host     => "localhost",
+  :username => "root",
+  :password => "",
+  :database => "test"
+}
+class River < ActiveRecord::Base; end
+class VeryLongRiver < ActiveRecord::Base; end

data/spec/mysql2legacydb/default_translator_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mysql2legacydb::DefaultTranslator do
+    EXAMPLE_MAPPINGS = {
+      'veryLongRivers' => 'very_long_rivers',
+      'rivers' => 'rivers'
+    }
+
+  before {
+    @translator = Mysql2legacydb::DefaultTranslator.new
+  }
+
+  describe "legacy_to_new" do
+    it "should underscore input" do
+      EXAMPLE_MAPPINGS.each do |legacy,new|
+        @translator.legacy_to_new(legacy).should == new
+      end
+    end
+
+    it "should be reversible" do
+      EXAMPLE_MAPPINGS.each do |legacy,new|
+        translated_new = @translator.legacy_to_new(legacy)
+        @translator.new_to_legacy(translated_new).should == legacy
+      end
+    end
+  end
+
+  describe "new_to_legacy" do
+    it "should camelcase underscores" do
+      EXAMPLE_MAPPINGS.each do |legacy,new|
+        @translator.new_to_legacy(new).should == legacy
+      end
+    end
+
+    it "should be reversible" do
+      EXAMPLE_MAPPINGS.each do |legacy,new|
+        translated_legacy = @translator.new_to_legacy(new)
+        @translator.legacy_to_new(translated_legacy).should == new
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'activerecord-mysql2legacydb-adapter'
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,250 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord-mysql2legacydb-adapter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Anders Johannsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        - pre3
+        version: 1.5.0.pre3
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        - pre3
+        version: 1.5.0.pre3
+  type: :development
+  prerelease: false
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id011
+description: "If you are stuck with a MySQL database where the naming is, well, unrailslike,\n    activerecord-mysql2-legacy-db-adapter offers a way to do the translation. It works at the driver level and doesn't\n    require you ro change the structure of the database. Also there are no database views which should be kept up to date\n    as you add or remove fields.\n  "
+email: anders@johannsen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_record/connection_adapters/mysql2legacydb_adapter.rb
+- lib/activerecord-mysql2legacydb-adapter.rb
+- lib/mysql2legacydb/default_translator.rb
+- nbproject/project.properties
+- nbproject/project.xml
+- spec/.rspec
+- spec/activerecord-mysql2legacydb-adapter_spec.rb
+- spec/mysql2legacydb/default_translator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/andersjo/activerecord-mysql2legacydb-adapter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1619170428146622390
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Translates table and field names of legacy databases
+test_files: 
+- spec/activerecord-mysql2legacydb-adapter_spec.rb
+- spec/mysql2legacydb/default_translator_spec.rb
+- spec/spec_helper.rb