database-model-generator 0.6.0

data/spec/oracle_model_generator_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+require 'support/oracle_connection'
+require 'oracle/model/generator'
+
+RSpec.describe Oracle::Model::Generator do
+  include_context 'Oracle connection'
+  
+  let(:generator) { described_class.new(connection) }
+
+  describe 'class information' do
+    it 'has the correct version number' do
+      expect(Oracle::Model::Generator::VERSION).to eq('0.5.0')
+    end
+  end
+
+  describe '#initialize' do
+    it 'accepts an OCI8 connection object' do
+      expect { described_class.new(connection) }.not_to raise_error
+    end
+
+    it 'sets up instance variables correctly' do
+      expect(generator.connection).to eq(connection)
+      expect(generator.constraints).to eq([])
+      expect(generator.primary_keys).to eq([])
+      expect(generator.foreign_keys).to eq([])
+      expect(generator.dependencies).to eq([])
+      expect(generator.belongs_to).to eq([])
+      expect(generator.column_info).to eq([])
+      expect(generator.table).to be_nil
+      expect(generator.model).to be_nil
+    end
+  end
+
+  describe '#generate' do
+    it 'responds to the generate method' do
+      expect(generator).to respond_to(:generate)
+    end
+
+    it 'works with a table name' do
+      expect { generator.generate('employees') }.not_to raise_error
+    end
+
+    it 'works with a view name' do
+      expect { generator.generate('emp_details_view', true) }.not_to raise_error
+    end
+
+    context 'when generating from a table' do
+      before { generator.generate('employees') }
+
+      it 'sets the table name in uppercase' do
+        expect(generator.table).to eq('EMPLOYEES')
+      end
+
+      it 'generates a model name from the table name' do
+        expect(generator.model).to eq('Employee')
+      end
+
+      it 'sets view to false' do
+        expect(generator.view).to be false
+      end
+
+      it 'populates column information' do
+        expect(generator.column_info).to be_an(Array)
+        expect(generator.column_info).not_to be_empty
+      end
+
+      it 'finds primary keys' do
+        expect(generator.primary_keys).to be_an(Array)
+        expect(generator.primary_keys).to include('employee_id')
+      end
+
+      it 'populates constraints information' do
+        expect(generator.constraints).to be_an(Array)
+        expect(generator.constraints).not_to be_empty
+      end
+    end
+
+    context 'when generating from a view' do
+      before { generator.generate('emp_details_view', true) }
+
+      it 'sets the table name in uppercase' do
+        expect(generator.table).to eq('EMP_DETAILS_VIEW')
+      end
+
+      it 'generates the correct model name' do
+        expect(generator.model).to eq('EmpDetailsView')
+      end
+
+      it 'sets view to true' do
+        expect(generator.view).to be true
+      end
+    end
+  end
+
+  describe '#model' do
+    it 'returns the active record model name' do
+      generator.generate('emp_details_view', true)
+      expect(generator).to respond_to(:model)
+      expect(generator.model).to eq('EmpDetailsView')
+    end
+
+    it 'removes trailing s from model names' do
+      generator.generate('employees')
+      expect(generator.model).to eq('Employee')
+    end
+  end
+
+  describe '#table' do
+    it 'returns the uppercased table name' do
+      generator.generate('emp_details_view', true)
+      expect(generator).to respond_to(:table)
+      expect(generator.table).to eq('EMP_DETAILS_VIEW')
+    end
+  end
+
+  describe '#primary_keys' do
+    it 'returns an array of primary keys' do
+      generator.generate('employees')
+      expect(generator.primary_keys).to be_an(Array)
+      expect(generator.primary_keys).to include('employee_id')
+    end
+  end
+
+  describe '#column_info' do
+    it 'returns an array of column metadata' do
+      generator.generate('employees')
+      expect(generator.column_info).to be_an(Array)
+      expect(generator.column_info.length).to be > 0
+    end
+  end
+
+  describe '#constraints' do
+    it 'returns an array of constraint information' do
+      generator.generate('employees')
+      expect(generator.constraints).to be_an(Array)
+      expect(generator.constraints).not_to be_empty
+    end
+  end
+
+  describe '#foreign_keys' do
+    it 'returns an array of foreign key names' do
+      generator.generate('employees')
+      expect(generator.foreign_keys).to be_an(Array)
+    end
+  end
+
+  describe '#belongs_to' do
+    it 'returns an array of parent tables' do
+      generator.generate('employees')
+      expect(generator.belongs_to).to be_an(Array)
+    end
+  end
+
+  describe '#dependencies' do
+    it 'returns an array of dependent objects' do
+      generator.generate('employees', true)
+      expect(generator).to respond_to(:dependencies)
+      expect(generator.dependencies).to be_an(Array)
+      
+      # Only check for Hash if there are dependencies
+      if generator.dependencies.any?
+        expect(generator.dependencies.first).to be_a(Hash)
+      end
+    end
+  end
+
+  describe '#view' do
+    it 'correctly identifies tables vs views' do
+      generator.generate('employees')
+      expect(generator.view).to be false
+      
+      generator.generate('emp_details_view', true)
+      expect(generator.view).to be true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# Load the library we're testing
+require_relative '../lib/oracle-model-generator'
+
+# RSpec configuration for Oracle Model Generator
+RSpec.configure do |config|
+  # Use the expect() syntax rather than should syntax
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # Use the new mock framework syntax
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Enable color output
+  config.color = true
+
+  # Use documentation format for output
+  config.formatter = :documentation
+
+  # Run specs in random order to surface order dependencies
+  config.order = :random
+
+  # Allow filtering tests by tags
+  config.filter_run_when_matching :focus
+
+  # Shared context for setting up test data
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

data/spec/support/oracle_connection.rb

@@ -0,0 +1,126 @@
+require 'oci8'
+
+# Shared context for Oracle database connection and test data
+RSpec.shared_context 'Oracle connection' do
+  before(:context) do
+    @oracle_connection = begin
+      # In Docker environment, use the service name instead of localhost
+      host = ENV['ORACLE_HOST'] || 'localhost'
+      port = ENV['ORACLE_PORT'] || '1521'
+      sid = ENV['ORACLE_SID'] || 'freepdb1'
+      database_str = "#{host}:#{port}/#{sid}"
+      
+      OCI8.new(
+        ENV['ORACLE_USER'] || 'hr',
+        ENV['ORACLE_PASSWORD'] || 'oracle',
+        database_str
+      )
+    rescue OCIError => e
+      warn "Database connection failed: #{e.message}"
+      warn "Make sure Oracle database is running and accessible"
+      warn "Connection string: #{ENV['ORACLE_HOST'] || 'localhost'}:#{ENV['ORACLE_PORT'] || '1521'}/#{ENV['ORACLE_SID'] || 'freepdb1'}"
+      warn "User: #{ENV['ORACLE_USER'] || 'hr'}"
+      raise e
+    end
+    setup_test_data
+  end
+
+  after(:context) do
+    # Cleanup test tables and views
+    cleanup_test_data
+    
+    # Close the connection
+    @oracle_connection&.logoff
+  end
+
+  # Use a method instead of let for context-level variables
+  def connection
+    @oracle_connection
+  end
+
+  private
+
+  def setup_test_data
+    # Create test tables and views if they don't exist
+    setup_sample_data
+  end
+
+  def cleanup_test_data
+    # Drop test views first (to avoid dependency issues)
+    begin
+      @oracle_connection.exec('DROP VIEW hr.employees_by_department') rescue nil
+    rescue => e
+      # Ignore errors if views don't exist
+    end
+
+    # Note: We don't drop HR schema tables as they might be used by other tests
+  end
+
+  def setup_sample_data
+    # Check if employees table exists and has data
+    begin
+      cursor = @oracle_connection.parse('SELECT COUNT(*) FROM employees')
+      cursor.exec
+      count = cursor.fetch[0]
+      cursor.close
+
+      if count == 0
+        # Insert sample data into employees table
+        @oracle_connection.exec(<<~SQL)
+          INSERT INTO employees (employee_id, first_name, last_name, email, phone_number,
+                               hire_date, job_id, salary, commission_pct, manager_id, department_id)
+          VALUES (1, 'John', 'Doe', 'john.doe@example.com', '555-1234',
+                  DATE '2020-01-15', 'IT_PROG', 5000, NULL, NULL, 60)
+        SQL
+
+        @oracle_connection.exec(<<~SQL)
+          INSERT INTO employees (employee_id, first_name, last_name, email, phone_number,
+                               hire_date, job_id, salary, commission_pct, manager_id, department_id)
+          VALUES (2, 'Jane', 'Smith', 'jane.smith@example.com', '555-5678',
+                  DATE '2021-03-10', 'IT_PROG', 5500, NULL, 1, 60)
+        SQL
+
+        @oracle_connection.commit
+      end
+
+      # Check if departments table exists and has data
+      cursor = @oracle_connection.parse('SELECT COUNT(*) FROM departments')
+      cursor.exec
+      dept_count = cursor.fetch[0]
+      cursor.close
+
+      if dept_count == 0
+        # Insert sample data into departments table
+        @oracle_connection.exec(<<~SQL)
+          INSERT INTO departments (department_id, department_name, manager_id, location_id)
+          VALUES (60, 'IT', 1, 1700)
+        SQL
+
+        @oracle_connection.exec(<<~SQL)
+          INSERT INTO departments (department_id, department_name, manager_id, location_id)
+          VALUES (50, 'Shipping', NULL, 1500)
+        SQL
+
+        @oracle_connection.commit
+      end
+
+      # Create a test view if it doesn't exist
+      begin
+        @oracle_connection.exec(<<~SQL)
+          CREATE OR REPLACE VIEW hr.employees_by_department AS
+          SELECT e.employee_id, e.first_name, e.last_name, e.email,
+                 d.department_name, d.department_id
+          FROM employees e
+          JOIN departments d ON e.department_id = d.department_id
+        SQL
+      rescue => e
+        # View creation might fail if tables don't exist yet, that's okay
+        warn "Could not create test view: #{e.message}"
+      end
+
+    rescue => e
+      warn "Could not set up sample data: #{e.message}"
+      # Continue with tests even if sample data setup fails
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: database-model-generator
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Daniel J. Berger
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+  A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+  u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+  75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+  6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+  iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+  ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+  74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+  058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+  AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+  YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+  /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+  h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+  6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+  ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+  1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+  DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+  ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+  WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+  -----END CERTIFICATE-----
+date: 2025-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: getopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: ruby-oci8
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: tiny_tds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+description: |2
+      The database-model-generator library allows you to generate an ActiveRecord
+      model from an existing Oracle table or view, as well as automatically
+      generate a baseline test file for test-unit or minitest.
+email: djberg96@gmail.com
+executables:
+- dmg
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGES.md
+- Gemfile
+- LICENSE
+- MANIFEST.md
+- README.md
+- Rakefile
+- bin/dmg
+- certs/djberg96_pub.pem
+- database-model-generator.gemspec
+- docker/README.md
+- docker/oracle/Dockerfile
+- docker/oracle/README.md
+- docker/oracle/docker-compose.yml
+- docker/oracle/test.sh
+- docker/sqlserver/DOCKER.md
+- docker/sqlserver/Dockerfile
+- docker/sqlserver/SUPPORT.md
+- docker/sqlserver/TESTING.md
+- docker/sqlserver/docker-compose.yml
+- docker/sqlserver/init-db.sql
+- docker/sqlserver/run_tests.sh
+- docker/sqlserver/setup-db.sh
+- docker/sqlserver/test-Dockerfile
+- docker/sqlserver/test.sh
+- lib/database_model_generator.rb
+- lib/oracle/model/generator.rb
+- lib/sqlserver/model/generator.rb
+- spec/oracle_model_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/oracle_connection.rb
+homepage: http://www.github.com/djberg96/database-model-generator
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A Ruby library for generating Rails AR models from existing tables.
+test_files:
+- spec/oracle_model_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/oracle_connection.rb