oracle-model-generator 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6cd1ef251b8ea5ee51565e983afc31dd0edd723
-  data.tar.gz: ffc7114624b085aed44870dd5a5dd06125c36d2a
+SHA256:
+  metadata.gz: b8f35e4437d649d4ba51871b95819456a0124d3e2b7deba20c70891d6067b71e
+  data.tar.gz: ec7b1645ca0e9af856003908b74ef0feb44deb5130f0d279874b6b56cb99c60f
 SHA512:
-  metadata.gz: 44795ef34f027eb882e4a82404be49e8d205769e7d925bd7751868fcedcddfb6dc02b979165a7f4c77571dec3bc6458ade58e8e9925956100ca402c1a4cef4c9
-  data.tar.gz: 5d934a9236ac6b7ddd771e20ed9c7c0b15d4e561792d932bdcd4363a1c402d3b83b46f1d108e583fafb7ddd97d9123b3f1d42856e1e72865902321ca0b673c08
+  metadata.gz: 869db7912de3481e85ff70e0e09ffc7b0bd795efe031e5411f8b48016e17be764d85cb9a8dbed9bb840e7501ada4fb47a4b95edd8d43e812b2d55784562e2ab1
+  data.tar.gz: ecc1acb26c4d4651cfab1912d00dfc491acff6dc2c1fa62de883969e716493247e6810d7af80d80a01bed27654e492b5ee8fcc364f6cb97702b57e900c23e9d5

data/{CHANGES → CHANGES.md}

@@ -1,23 +1,29 @@
-= 0.4.1 - 1-Feb-2016
+## 0.5.0 - 22-Jul-2025
+* Added docker related files, so you can now fire up an Oracle container and
+  run the specs against that.
+* Replaced test-unit with rspec.
+* Changed the license to Apache-2.0.
+
+## 0.4.1 - 1-Feb-2016
 * This gem is now signed.
 * Updated the gem related tasks in the Rakefile.
 * Added an oracle-model-generator.rb file for convenience.
 
-= 0.4.0 - 7-Nov-2014
+## 0.4.0 - 7-Nov-2014
 * Added support for minitest test file output.
 
-= 0.3.2 - 6-Nov-2014
+## 0.3.2 - 6-Nov-2014
 * Removed explicit references to Rails 3 in documentation. It's now simply
   Rails 2, or Rails 3 or higher.
 * Some minor updates in generated test file text, as test-unit 2 no longer
   requires the require workaround.
 * Updates to Rakefile and gemspec.
 
-= 0.3.1 - 3-Apr-2012
+## 0.3.1 - 3-Apr-2012
 * Added the --class option that allows you to specify the model name on the
   command line. Thanks go to Daniel Luna for the patch (plus some minor fixes).
 
-= 0.3.0 - 12-May-2011
+## 0.3.0 - 12-May-2011
 * Added automatic test generation. In addition to the active record model file,
   a test file will be generated that includes a series of stock tests that
   are based on the model's validations. At the moment only test-unit is
@@ -31,12 +37,12 @@
 * The default output file name will now chop any trailing 's' characters.
 * More tests and comments added.
 
-= 0.2.1 - 3-May-2011
+## 0.2.1 - 3-May-2011
 * Fixed a bug where the omg binary blew up if you didn't have the dbi-dbrc
   library installed. It's supposed to be optional. Thanks go to Jason Roth
   for the spot.
 
-= 0.2.0 - 8-Mar-2011
+## 0.2.0 - 8-Mar-2011
 * Added the -r/--rails command line option. By default the omg binary will
   now generate Rails 3 style validations. If you want Rails 2 validations,
   specify "-r 2" on the command line.
@@ -44,5 +50,5 @@
   scale and precision exactly as defined instead of rounding to the nearest
   whole number, for Rails 3 anyway.
 
-= 0.1.0 - 6-Oct-2010
+## 0.1.0 - 6-Oct-2010
 * Initial release.

data/DOCKER.md

@@ -0,0 +1,152 @@
+# Docker Testing Environment for Oracle Model Generator
+
+This directory contains Docker configuration files to create a complete testing environment for the oracle-model-generator library.
+
+## Quick Start
+
+### Using Docker Compose (Recommended)
+
+The easiest way to test the library is using Docker Compose, which will start both an Oracle database and the testing environment:
+
+```bash
+# Build and start the services
+docker-compose up --build
+
+# This will:
+# 1. Download and start Oracle Express Edition
+# 2. Build the oracle-model-generator testing image
+# 3. Set up the HR sample schema
+# 4. Start an interactive shell in the testing container
+```
+
+### Manual Docker Build
+
+If you prefer to build just the testing image:
+
+```bash
+# Build the Docker image
+docker build -t oracle-model-generator-test .
+
+# Run with a separate Oracle database
+docker run -it --rm \
+  -e ORACLE_HOST=your-oracle-host \
+  -e ORACLE_PORT=1521 \
+  -e ORACLE_USER=hr \
+  -e ORACLE_PASSWORD=hr \
+  oracle-model-generator-test
+```
+
+## Running Tests
+
+Once inside the container, you can run various commands:
+
+```bash
+# Run the Docker environment test to verify everything is working
+bundle exec ruby test/docker_environment_test.rb
+
+# Run the test suite
+bundle exec ruby test/test_oracle_model_generator.rb
+
+# Test the command-line tool
+bundle exec ruby -Ilib bin/omg --help
+
+# Interactive Ruby with the library loaded
+irb -I lib -r oracle/model/generator
+```
+
+## Environment Variables
+
+The Docker environment supports these environment variables:
+
+- `ORACLE_HOST`: Oracle database hostname (default: localhost)
+- `ORACLE_PORT`: Oracle database port (default: 1521)
+- `ORACLE_SID`: Oracle database SID (default: XE)
+- `ORACLE_USER`: Database username (default: hr)
+- `ORACLE_PASSWORD`: Database password (default: hr)
+
+## Summary
+
+The Docker setup provides a robust testing environment for the Oracle Model Generator that:
+
+- ✅ Works on all platforms (Linux, macOS, Windows)
+- ✅ Includes Oracle Instant Client and ruby-oci8
+- ✅ Has comprehensive environment verification
+- ✅ Supports both standalone and full-stack testing
+- ✅ Uses optimized gem installation for containers
+- ⚠️  Oracle XE database has some macOS compatibility limitations
+
+This gives you a reliable way to test Oracle connectivity without installing Oracle client libraries on your host system.
+
+## Troubleshooting
+
+### macOS Docker Issues
+
+On macOS, you might encounter shared memory issues with the Oracle XE container:
+
+```
+ORA-27104: system-defined limits for shared memory was misconfigured
+```
+
+**Workaround**: Test the application container directly:
+
+```bash
+# Build and test just the application
+docker build -t oracle-model-generator-test .
+
+# Run the environment verification test
+docker run --rm oracle-model-generator-test bundle exec ruby test/docker_environment_test.rb
+
+# Interactive testing without database
+docker run -it --rm oracle-model-generator-test bash
+```
+
+### Connection Issues
+
+If you get Oracle connection errors:
+
+1. Check that the Oracle database is running: `docker-compose ps`
+2. Wait for the database to be fully initialized (can take 2-3 minutes)
+3. Verify connection parameters match your setup
+
+### Build Issues
+
+If the Docker build fails:
+
+1. Make sure you have internet access (downloads Oracle Instant Client)
+2. Try rebuilding: `docker-compose build --no-cache`
+
+### Test Failures
+
+If tests fail but connection works:
+
+1. Verify the HR schema is properly installed
+2. Check that sample data is present
+3. Ensure the user has necessary permissions
+
+## Development
+
+To develop/debug the library using Docker:
+
+```bash
+# Start the container with a bash shell
+docker-compose run oracle-model-generator bash
+
+# Or mount the local directory for live editing
+docker run -it --rm -v $(pwd):/app oracle-model-generator-test bash
+```
+
+## Cleaning Up
+
+To remove all Docker resources:
+
+```bash
+# Stop and remove containers
+docker-compose down
+
+# Also remove volumes (this will delete the Oracle database data)
+docker-compose down -v
+
+# Remove the built images
+docker rmi oracle-model-generator-test
+docker rmi gvenzl/oracle-xe:21-slim
+```

data/Dockerfile

@@ -0,0 +1,87 @@
+# Dockerfile for testing oracle-model-generator library
+FROM ruby:3.1-bullseye
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    wget \
+    unzip \
+    libaio1 \
+    libaio-dev \
+    build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+# Download and install Oracle Instant Client
+WORKDIR /opt/oracle
+RUN wget https://download.oracle.com/otn_software/linux/instantclient/1913000/instantclient-basic-linux.x64-19.13.0.0.0dbru.zip && \
+    wget https://download.oracle.com/otn_software/linux/instantclient/1913000/instantclient-sdk-linux.x64-19.13.0.0.0dbru.zip && \
+    unzip instantclient-basic-linux.x64-19.13.0.0.0dbru.zip && \
+    unzip instantclient-sdk-linux.x64-19.13.0.0.0dbru.zip && \
+    rm -f *.zip
+
+# Set Oracle environment variables
+ENV ORACLE_HOME=/opt/oracle/instantclient_19_13
+ENV LD_LIBRARY_PATH=$ORACLE_HOME
+ENV PATH=$ORACLE_HOME:$PATH
+
+# Create symbolic links for OCI8 compilation
+RUN cd $ORACLE_HOME && \
+    ln -sf libclntsh.so.19.1 libclntsh.so && \
+    ln -sf libocci.so.19.1 libocci.so
+
+# Set working directory for the application
+WORKDIR /app
+
+# Copy gemspec and Gemfile first for better Docker layer caching
+COPY oracle-model-generator.gemspec Gemfile ./
+
+# Install Ruby dependencies
+RUN bundle config set --local deployment false && \
+    bundle install --verbose
+
+# Copy the rest of the application
+COPY . .
+
+# Create a script to run tests with Oracle connection
+RUN echo '#!/bin/bash\n\
+echo "Starting Oracle Model Generator test environment..."\n\
+echo ""\n\
+echo "This Docker container includes:"\n\
+echo "- Ruby $(ruby --version)"\n\
+echo "- Oracle Instant Client 19.13"\n\
+echo "- All required gems for oracle-model-generator"\n\
+echo ""\n\
+echo "To run tests, you need to:"\n\
+echo "1. Have an Oracle database running (Oracle XE recommended)"\n\
+echo "2. Ensure the '\''hr'\'' schema is available with sample data"\n\
+echo "3. Update connection parameters in test file if needed"\n\
+echo ""\n\
+echo "Available commands:"\n\
+echo "  bundle exec ruby test/test_oracle_model_generator.rb  # Run tests"\n\
+echo "  bundle exec ruby -Ilib bin/omg --help                # Run CLI tool"\n\
+echo "  irb -I lib -r oracle/model/generator                 # Interactive Ruby"\n\
+echo ""\n\
+echo "Current Oracle environment:"\n\
+echo "  ORACLE_HOME: $ORACLE_HOME"\n\
+echo "  LD_LIBRARY_PATH: $LD_LIBRARY_PATH"\n\
+echo ""\n\
+\n\
+# Check if arguments were passed to run specific commands\n\
+if [ $# -eq 0 ]; then\n\
+    echo "No command specified. Starting bash shell..."\n\
+    exec /bin/bash\n\
+else\n\
+    exec "$@"\n\
+fi' > /app/run_tests.sh
+
+RUN chmod +x /app/run_tests.sh
+
+# Expose any ports that might be needed (none for this library)
+# EXPOSE 8080
+
+# Set the default command
+CMD ["/app/run_tests.sh"]
+
+# Add some helpful labels
+LABEL maintainer="Testing Environment for oracle-model-generator"
+LABEL description="Docker image for testing the oracle-model-generator Ruby library with Oracle Instant Client"
+LABEL version="1.0"

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/{MANIFEST → MANIFEST.md}

@@ -1,6 +1,6 @@
-CHANGES
-MANIFEST
-README
+CHANGES.md
+MANIFEST.md
+README.md
 oracle-model-generator.gemspec
 Rakefile
 bin/omg

data/README-Docker.md

@@ -0,0 +1,140 @@
+# Docker Testing Environment for Oracle Model Generator
+
+This directory contains a complete Docker setup for testing the oracle-model-generator Ruby library with Oracle database connectivity.
+
+## Files Created
+
+### Docker Configuration
+- `Dockerfile` - Production-ready Docker image with Oracle connectivity
+- `docker-compose.yml` - Complete testing environment with Oracle XE database
+- `.dockerignore` - Optimizes Docker build context
+
+### Testing Files
+- `test/test_oracle_model_generator_docker.rb` - Docker-optimized test suite
+- `DOCKER.md` - Detailed documentation and troubleshooting guide
+
+## Quick Start
+
+### Option 1: Full Testing Environment (with Oracle Database)
+
+1. **Start the complete environment:**
+   ```bash
+   docker-compose up -d
+   ```
+
+2. **Wait for Oracle database to be ready:**
+   ```bash
+   docker-compose logs -f oracle-db
+   # Wait for "DATABASE IS READY TO USE!" message
+   ```
+
+3. **Run tests:**
+   ```bash
+   docker-compose exec app ruby test/test_oracle_model_generator_docker.rb
+   ```
+
+4. **Interactive shell for development:**
+   ```bash
+   docker-compose exec app bash
+   ```
+
+### Option 2: Build and Test Application Only
+
+1. **Build the image:**
+   ```bash
+   docker build -t oracle-model-generator .
+   ```
+
+2. **Run with external database:**
+   ```bash
+   docker run -e ORACLE_HOST=your-db-host \
+              -e ORACLE_PORT=1521 \
+              -e ORACLE_SID=your-sid \
+              -e ORACLE_USER=your-user \
+              -e ORACLE_PASSWORD=your-password \
+              oracle-model-generator
+   ```
+
+## Environment Variables
+
+The Docker environment supports these variables for database connection:
+
+- `ORACLE_HOST` - Database hostname (default: oracle-db)
+- `ORACLE_PORT` - Database port (default: 1521)
+- `ORACLE_SID` - Database SID (default: XE)
+- `ORACLE_USER` - Database username (default: hr)
+- `ORACLE_PASSWORD` - Database password (default: oracle)
+
+## What's Included
+
+### Oracle Instant Client 19.13
+- Full Oracle connectivity libraries
+- Properly configured environment variables
+- Native compilation support for ruby-oci8
+
+### Ruby Environment
+- Ruby 3.1 with bundler
+- All project dependencies installed
+- Optimized for Oracle development
+
+### Test Database (via docker-compose)
+- Oracle Express Edition 21c
+- Pre-configured HR sample schema
+- Ready-to-use test data
+
+## Development Workflow
+
+1. **Make code changes** in your local workspace
+2. **Rebuild the image:** `docker-compose build app`
+3. **Run tests:** `docker-compose exec app ruby test/test_oracle_model_generator_docker.rb`
+4. **Debug interactively:** `docker-compose exec app bash`
+
+## Troubleshooting
+
+### Common Issues
+
+1. **ruby-oci8 compilation errors:**
+   - Ensure Oracle Instant Client is properly installed
+   - Check environment variables are set correctly
+   - Verify build-essential package is installed
+
+2. **Database connection failures:**
+   - Wait for Oracle container to fully initialize
+   - Check network connectivity between containers
+   - Verify database credentials
+
+3. **Permission issues:**
+   - Ensure Docker has necessary permissions
+   - Check file ownership in mounted volumes
+
+### Debugging Commands
+
+```bash
+# Check Oracle client installation
+docker-compose exec app ls -la /opt/oracle/instantclient_19_13/
+
+# Test database connectivity
+docker-compose exec app sqlplus hr/oracle@oracle-db:1521/XE
+
+# Check environment variables
+docker-compose exec app env | grep ORACLE
+
+# View bundler gem installation
+docker-compose exec app bundle list
+```
+
+## Performance Notes
+
+- Initial build takes 10-15 minutes (Oracle client compilation)
+- Subsequent builds use Docker layer caching
+- Oracle database initialization takes 2-3 minutes
+- Consider using volumes for persistent development
+
+## Security Considerations
+
+- Default passwords are for development only
+- Use Docker secrets for production deployments
+- Limit network exposure in production environments
+- Regular security updates for base images
+
+For detailed information, see `DOCKER.md`.