data_factory 0.1.1 → 0.1.2

data/README.md

@@ -1,6 +1,6 @@
 # DataFactory
 
-DataFactory is a simple Ruby gem that generates data random test data and inserts it into database tables. It was created to help with unit testing in a project that had database tables having many (50+) columns, and manually crafing insert statements was tedious and error prone.
+DataFactory is a simple Ruby gem that generates random test data and inserts it into database tables. It was created to help with unit testing in a project that had database tables having many (50+) columns, and manually crafing insert statements was tedious and error prone.
 
 DataFactory reads the table definition from the database, and generates random values for all not null columns. It inserts this data into the table, while providing the option of specifying non-random defaults.
 
@@ -16,7 +16,7 @@ There are no strict dependencies for DataFactory to work, and it is a pure Ruby
 
 However, DataFactory doesn't actually have a database access layer built in, as it is designed to use an external access layer that knows how to connect and query the database. 
 
-If you can use JRuby, consider using Simple JDBC Oracle to interact with your database. If you cannot use JRuby, implementing your own database interface is simple. Create a class that handles creating a database connection, and implement the following three methods to run SQL statements on the database, and issue commits:
+If you can use JRuby, consider using Simple JDBC Oracle to interact with your database. If you cannot use JRuby, implementing your own database interface is not too difficult. Create a class that handles creating a database connection, and implement the following three methods to run SQL statements on the database, and issue commits:
 
     # should return an object that implements the each_array method
     # below
@@ -29,7 +29,7 @@ If you can use JRuby, consider using Simple JDBC Oracle to interact with your da
     def each_array(&blk)
     end
 
-The first two methods are fairly obvious. The each_array method is expected to iterate over the result set returned by the executed sql statement, passing an array of columns to the block for each row returned. The array should contain the value of each column in Ruby types, ie not Java types if using JRuby.
+The first two methods are fairly obvious. The each_array method is expected to iterate over the result set returned by the executed sql statement, ie execute_sql should return an object that responds to each_array. The each_array method accepts a block, and will pass an array to the block for each row in the result set. The array passed to the block should contain an element for each column selected by the original query. The array should contain the value of each column in Ruby types, ie not Java types if using JRuby.
 
 The OCI8 gem is pretty good place to start if you are using MRI Ruby, but you will need the Oracle client installed. Raw JDBC can get the job done if you are using JRuby and you do not want to use Simple JDBC Oracle.
 
@@ -44,7 +44,7 @@ For these examples to run, create a table on the database as follows:
                             first_name varchar2(50),
                             last_name  varchar2(50),
                             email      varchar2(50),
-                            ssn        varchar2(10));
+                            ssn        varchar2(10) not null);
 
 ## Define a DataFactory Class
 
@@ -85,6 +85,28 @@ The create! call will take the column defaults defined in the Employee class, an
 
 An Employee instance is returned, containing all the generated values.
 
+There is also a create method that works just like create! but does not issue a commit.
+
+Finally there is a build method that creates an instance of the class with default and generated values, but does not insert it into the database at all.
+
+## Accessing The Column Values
+
+When an instance of a DataFactory class is created, you can access the generated values for the columns with the column_values method, which returns a hash. The keys of the hash are the uppercase column names and the values contain the generated data:
+
+    f.column_values.keys.each do |k|
+      puts "#{k} :: #{f.column_values[k]}"
+    end
+
+    # EMP_ID :: 1001
+    # DEPT_ID ::
+    # FIRST_NAME ::
+    # LAST_NAME :: Smith
+    # EMAIL :: 4506@5941.com
+    # SSN :: Gb3
+
+Notice how columns that are nullable, have not got a default value and were not passed a value are generated with null values.
+
+
 ## Putting It Together
 
 Combining each of the steps above, gives the following script:
@@ -114,14 +136,43 @@ Combining each of the steps above, gives the following script:
     f = Employee.create!("emp_id" => 1001)
     
     f.column_values.keys.each do |k|
-      puts f.column_values[k]
+      puts "#{k} :: #{f.column_values[k]}"
     end
 
 ## Other Methods
 
 The sample above illustrates how the create! method returns an Employee object, giving access to the generated values. For an overview of other methods browse the documentation for the base_api, base_dsl and base_factory methods.
 
+## Using multiple Database connections
+
+If you look at the source for the Base class, you can see it doesn't define any methods on its own:
+
+    class Base
+    
+      extend BaseDSL
+      extend BaseFactory
+    
+      include BaseAPI
+    
+    end
+
+In the examples above, the database interface is set by calling the set_database_interface method on Base:
+
+    DataFactory::Base.set_database_interface(interface)
+
+Behind the scenes, this sets a class variable which is inherited by all other classes that inherit from Base - in other words, once you set the database interface on Base, that connection is shared by all sub classes.
+
+This creates a problem if you need to have connections to multiple databases, with some Data Factory classes pointing to one database and other to another. To work around this, you can easily create a new Base class to inherit from, by including the relevant Data Factory modules:
+
+    class NewBase
+      extend DataFactory::BaseDSL
+      extend DataFactory::BaseFactory
+
+      include DataFactory::BaseAPI
+
+    end
 
+I may make improvements in the future to remove this limitation and improve the design.
 
 
 

data/lib/data_factory/base_api.rb

@@ -170,7 +170,7 @@ module DataFactory
       when 'NUMBER', 'INTEGER'
         scale = 2
         if col.data_scale && col.data_scale == 0
-          1
+          random_integer(9999)
         else
           22.23
         end

metadata

@@ -1,77 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: data_factory
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.1.1
+  version: 0.1.2
+  prerelease: 
 platform: ruby
 authors:
 - Stephen O'Donnell
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies: []
-description: Generates data to insert into database tables, allowing columns to be defaulted or overriden. Intended to be used when testing wide tables where many not null columns may need to be populated but are not part of the test
+description: Generates data to insert into database tables, allowing columns to be
+  defaulted or overriden. Intended to be used when testing wide tables where many
+  not null columns may need to be populated but are not part of the test
 email: stephen@betteratoracle.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- !binary |-
-  dGVzdC9iYXNlX2FwaV90ZXN0LnJi
-- !binary |-
-  dGVzdC9iYXNlX2RzbF90ZXN0LnJi
-- !binary |-
-  dGVzdC9oZWxwZXIucmI=
-- !binary |-
-  dGVzdC9zYW5pdHkucmI=
-- !binary |-
-  dGVzdC90ZXN0X3J1bm5lci5yYg==
-- !binary |-
-  bGliL2RhdGFfZmFjdG9yeS5yYg==
-- !binary |-
-  bGliL2RhdGFfZmFjdG9yeS9iYXNlLnJi
-- !binary |-
-  bGliL2RhdGFfZmFjdG9yeS9iYXNlX2FwaS5yYg==
-- !binary |-
-  bGliL2RhdGFfZmFjdG9yeS9iYXNlX2RzbC5yYg==
-- !binary |-
-  bGliL2RhdGFfZmFjdG9yeS9iYXNlX2ZhY3RvcnkucmI=
-- !binary |-
-  bGliL2RhdGFfZmFjdG9yeS9jb2x1bW4ucmI=
-- !binary |-
-  bGliL2RhdGFfZmFjdG9yeS9leGNlcHRpb25zLnJi
-- !binary |-
-  bGliL2RhdGFfZmFjdG9yeS9yYW5kb20ucmI=
-- !binary |-
-  UmFrZWZpbGUucmI=
-- !binary |-
-  UkVBRE1FLm1k
+- test/base_api_test.rb
+- test/base_dsl_test.rb
+- test/helper.rb
+- test/sanity.rb
+- test/test_runner.rb
+- lib/data_factory/base.rb
+- lib/data_factory/base_api.rb
+- lib/data_factory/base_dsl.rb
+- lib/data_factory/base_factory.rb
+- lib/data_factory/column.rb
+- lib/data_factory/exceptions.rb
+- lib/data_factory/random.rb
+- lib/data_factory.rb
+- Rakefile.rb
+- README.md
 homepage: http://betteratoracle.com
 licenses: []
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.25
-signing_key:
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
 specification_version: 3
-summary: A gem to generate template insert statements for use when unit testing database code
+summary: A gem to generate template insert statements for use when unit testing database
+  code
 test_files: []
+has_rdoc: true