ar-model-generator 0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ar-model-generator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Changeme
+
+MIT License
+
+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.md

@@ -0,0 +1,50 @@
+# Ar::Model::Generator
+
+Fast generation of activerecord scaffold models to an existing (mysql?) database.
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ar-model-generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar-model-generator
+
+## Usage
+
+Run:
+```bash
+ar-model-generator
+```
+
+The programm will ask you about the connection details for the database as well as the namespace. Afterwards it will generate all model files under PWD/app/models/NAMESPACE.
+
+Only tested with mysql2 so far.
+
+There are some corrections:
+
+* if there is no 'id' column, there will be a ``self.primary_key = 'key'`` line in the model, with the first column which has "id" inside it's name
+* if there is a type column, there will be a ``self.inheritance_column = :sti_type``, otherwise there are conflicts
+* All models inherit from YourNamespace::Base, which is a abstract class to hold the connection information. The benefit is, that you can connect to multple databases, e.g. all Models under YourNamespace will use that connection instead your global development/production etc.
+
+Usage of classes:
+
+in your initializers:
+
+```ruby
+MyNamespace::Base.establish_connection :some_database_yml_key
+
+# Now you can use your models like:
+
+MyNamespace::User.where(:all_the_awesomeness => true)
+```
+
+## warning:
+
+* no generation of habtm hm belongs\_to
+* no composited primary keys

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/ar-model-generator.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Stefan Wienert"]
+  gem.email         = ["stefan.wienert@pludoni.de"]
+  gem.description   = %q{Useful to generate namespaced database models for a legacy database}
+  gem.summary       = %q{We used this, to generate the basic scaffold of our 50+ tables legacy database. This gem subclasses each of the models in a given namespace which inherits from a namespace::Base class. }
+  gem.homepage      = "https://github.com/zealot128/ar-model-generator"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ar-model-generator"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.3"
+  gem.add_dependency "activerecord"
+  gem.add_dependency "highline"
+  gem.add_dependency "mysql2"
+  gem.add_dependency "activerecord-mysql2-adapter"
+  gem.add_development_dependency "rake"
+end

data/bin/ar-model-generator

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "ar-model-generator"
+
+
+ArModelGenerator.cli

data/lib/ar-model-generator.rb

@@ -0,0 +1,84 @@
+require "highline"
+require "active_record"
+require "active_support/all"
+require "fileutils"
+module ArModelGenerator
+  module_function
+  def cli
+
+    connection = {}
+    connection[:database] = h.ask "Database Name?"
+    connection[:username] = h.ask "Database User?"
+    connection[:password] = h.ask "Database Password? (not shown)" do |q|
+       q.echo = false
+    end
+    connection[:adapter] = h.ask "Database Adapter?", lambda{|s| s.to_sym} do |q|
+      q.default = :mysql2
+    end
+    connection[:host] = h.ask "Database Host?" do |q|
+      q.default = "localhost"
+    end
+
+    ActiveRecord::Base.establish_connection connection
+    ActiveRecord::Base.connection
+    $stdout.puts h.color("Connection established", :green)
+
+    namespace = h.ask "Namespace for models (lowercase singular ok)?"
+    create_models(namespace, connection)
+
+    $stdout.puts "DONE. please look inside the Base.rb and delete/replace
+    connection information with something like :#{namespace.downcase} from your database.yml"
+  end
+
+  def h
+    @h ||= HighLine.new
+  end
+
+  def create_models(namespace, connection)
+    path = "app/models/#{namespace}/"
+    namespace_up = namespace.classify
+    FileUtils.mkdir_p path
+
+    # Base-File
+    base_path = path + "base.rb"
+    File.open(base_path , "w+") do |f|
+      f.write "class #{namespace_up}::Base < ActiveRecord::Base\n  self.abstract_class = true\n  establish_connection(#{connection.inspect}) end\n"
+    end
+    $stdout.puts h.color("Writing #{base_path}", :green)
+
+    ActiveRecord::Base.connection.tables.each do |table_name|
+      table_up = table_name.classify
+      string = "class #{namespace_up}::#{table_up} < #{namespace_up}::Base\n  self.table_name = '#{table_name}'"
+
+      if table_has_type_column?(table_name)
+        $stderr.puts "Table #{table_name} has column :type. Adding inheritance_column."
+        string += "\n  self.inheritance_column = :sti_type"
+      end
+      string += add_table_id_column(table_name)
+      string += "\nend\n"
+
+      target_path = path + "#{table_up.underscore}.rb"
+      $stdout.puts h.color("Writing #{namespace_up}::#{table_up} to #{target_path}", :green)
+      File.open(target_path, "w+") { |f|
+        f.write string
+      }
+    end
+  end
+
+  def table_has_type_column?(table)
+    ActiveRecord::Base.connection.columns(table).map(&:name).include? "type"
+  end
+
+  def add_table_id_column(table)
+    columns = ActiveRecord::Base.connection.columns(table).map(&:name)
+    return "" if columns.include? "id"
+    if col = columns.find{|i| i[/id$/i]}
+      message = "Automatically inferred ID colum of #{table} to #{col}"
+      $stderr.puts
+      "\n  self.primary_key = '#{col}'\n  # #{message}\n"
+    else
+      $stderr.puts "WARNING: Could not determine id-colum of #{table}"
+      ""
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: ar-model-generator
+version: !ruby/object:Gem::Version
+  version: '0.3'
+  prerelease: 
+platform: ruby
+authors:
+- Stefan Wienert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-mysql2-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Useful to generate namespaced database models for a legacy database
+email:
+- stefan.wienert@pludoni.de
+executables:
+- ar-model-generator
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ar-model-generator.gemspec
+- bin/ar-model-generator
+- lib/ar-model-generator.rb
+homepage: https://github.com/zealot128/ar-model-generator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2474709819767188495
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2474709819767188495
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: We used this, to generate the basic scaffold of our 50+ tables legacy database.
+  This gem subclasses each of the models in a given namespace which inherits from
+  a namespace::Base class.
+test_files: []