dummy 0.6 → 0.9

data/CHANGELOG.md

@@ -1,55 +1,5 @@
-## 0.1 (July 13, 2010)
+## 0.9 (August 10, 2010)
 
 Features:
-  - added generation of dummy data based on a Rails 3 application
-
-
-## 0.2 (July 17, 2010)
-
-Features:
-  - moved data generation into a generator
-  - added growth-ratio and base-amount options
-  
-
-## 0.3 (July 21, 2010)
-
-Features:
-  - added rake task to import the generated dummy data in the target application
-
-
-## 0.4 (July 24, 2010)
-
-Features:
-  - improved data generation (which tries to be smart, RIP lorem ipsum)
-
-  
-## 0.5 (July 24, 2010)
-
-Features:
-  - added tests for the data generators and rails generator
-  - small improvements
-  - added documentation
-  
-Fixes:
-  - various minor bugs
-  
-## 0.5.1 (July 29, 2010)
-
-Fixes:
-  - fixed a bug where magic integers were being returned as strings
-  
-## 0.5.2 (July 30, 2010)
-
-Features:
-  - added option to manually configure the amount of records to generate for each model
-  
-## 0.6 (July 31, 2010)
-
-Features:
-  - added option to define the output folder where the YAML files are placed
-  
-Fixes:
-  - Removed unused core extensions (for now)
-  - fixed some outdated tests
-  
+  - cleverly generating dummy data (functionality split up from old project)
 

data/README.md

@@ -1,10 +1,10 @@
 # Dummy
 
-Dummy generates dummy data for your Rails 3 application and allows you to import it.
+Dummy generates dummy data in a clever way.
 
 ## Description
 
-Dummy generates data for your application by inspecting your models and their associations. It tries to generate the correct type of data for each column by guessing what it is from its name. Finally, it allows you to import the generated data into the database.
+Dummy can generate a lot of dummy data from company names to postal codes. While it allows you to specifically request a type of information, it can also try to determine what you're looking for given a couple of parameters.
 
 ## Installation
 
@@ -12,28 +12,7 @@ $ gem install dummy
 
 ## Usage
 
-Add the following to the Gemfile of your Rails 3 application:
-    gem "dummy"
-    
-Now you have access to the generator:
-    rails generate dummy:data
-    
-You can change the base amount of records and the growth ratio (what these mean exactly is explained latter on):
-    rails generate dummy:data --base-amount 5 --growth-ratio 1.5
-    
-Also, you can manually define the amount of records to generate for each model (or just accept the defaults):
-    rails generate dummy:data --manual-amounts
-    
-And you can manually set the output folder for the YAML files (which defaults to test/dummy/data):
-    rails generate dummy:data --output-folder test/awesome_fixtures
-
-    
-The fixtures are stored in _test/dummy/_ while a rake file is placed in _lib/tasks/dummy.rake_. It allows you to import the generated data into the database:
-    RAILS_ENV="dummy" rake dummy:data:import
-
-Don't forget to change RAILS_ENV to whatever is appropriate for you (and is configured under databases.yml). Your database doesn't need to be empty.
-
-Another less conventional way of using dummy is to directly use its magic data generation:
+To ask for cleverly generated dummy data:
     Dummy.magic_data(field, type)
     
 Example:
@@ -44,43 +23,20 @@ Example:
     Dummy.magic_data("state", :string) => "Louisiana"
     Dummy.magic_data("lat", :float) => -86.718683637
     Dummy.magic_data("phone", :integer) => 9462876293
-
-
-## More information
-
-### Smart data
-
-Dummy tries to understand your database columns and generates data accordingly, instead of dumping "Lorem ipsum" all over the place.
-
-For instance, if you have a field called _company\_name_, it will generate a company name. If you have a field called _awesome\_postal\_code_, it will generate a valid ZIP Code. If you have a field called _longitude_, it will generate a valid longitude. And so on. You get the picture.
-
-Dummy cares about associations. It will create random associations between the automatically generated records.
-
-### Smart amounts of data
-
-Dummy is aware that the amount of records that each model has in real world applications is different. For this reason, it will analyze your model associations to try to make a somewhat accurate estimation of the expected amount of records.
-
-To illustrate this, consider an application with models for _Child_, _Parent_ and _GrandParent_. If the base amount is 10, the growth ratio is 2.0, and the models look like the following:
-
-    class GrandParent < ActiveRecord::Base  
-      has_many :parents
-    end
     
-    class Parent < ActiveRecord::Base
-      belongs_to :grand_parent
-      has_many :children
-    end
+You can also use its submodules for specific data:
+    Dummy::Name.first_name => "Muhammad"
+    Dummy::Internet.url => "https://david.grady.biz" 
+    Dummy::Address.street_address => "10273 Delaney Extensions"
     
-    class Child < ActiveRecord::Base
-        belongs_to :parent
-    end`
+Have a look in the rdoc for all available generators.
 
-The generator will create dummy data for 10 _GrandParents_, 20 _Parents_ and 40 _Children_.
+## More information
 
 ### Caveats
 
 Dummy has a few caveats which are on the TODO list. Those are:
-* It is an English speaking gem. It will not be smart at all if your column is named _telefone_ (Portuguese for _phone_) or if you want a zip code from outside the US.
-* It will generate valid emails, latitudes, street addresses, etc, but it doesn't care about your model validations.
+
+*   It is an English speaking gem. It will not be smart at all if your column is named _telefone_ (Portuguese for _phone_) or if you want a zip code from outside the US.
 
 Copyright (c) 2010 Gonçalo Silva

data/lib/dummy/lorem.rb

@@ -17,7 +17,7 @@ module Dummy
     end
 
     def paragraphs
-      (1..3).map { paragraph }.join("\n")
+      (1..3).map { paragraph }.join(" ") # removing \n because of ruby's syck bug
     end
     
     private

data/lib/dummy.rb

@@ -7,11 +7,10 @@ require "dummy/lorem"
 require "dummy/name"
 require "dummy/phone_number"
 require "dummy/geolocation"
-require "generators/dummy_generator"
 
 module Dummy
   class << self
-    
+      
     def magic_data(field, type)
       case type
       when :string, :text then magic_string(field, type)

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  version: "0.6"
+  - 9
+  version: "0.9"
 platform: ruby
 authors: 
 - "Gon\xC3\xA7alo Silva"
@@ -13,26 +13,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-31 00:00:00 +01:00
+date: 2010-08-11 00:00:00 +01:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 0
-        - rc
-        version: 3.0.0.rc
-  type: :runtime
-  version_requirements: *id001
-description: Generates consistent fake data and allows you to insert it to the database
+dependencies: []
+
+description: A Ruby library to generate clever dummy data
 email: 
 - goncalossilva@gmail.com
 executables: []
@@ -52,9 +37,7 @@ files:
 - lib/dummy/internet.rb
 - lib/dummy/geolocation.rb
 - lib/dummy/phone_number.rb
-- lib/generators/dummy_generator.rb
 - lib/dummy.rb
-- lib/generators/templates/dummy.rake
 - LICENSE
 - README.md
 - CHANGELOG.md
@@ -91,6 +74,6 @@ rubyforge_project: dummy
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Generates and imports dummy data for Rails 3 applications
+summary: Generates dummy data
 test_files: []
 

data/lib/generators/dummy_generator.rb

@@ -1,194 +0,0 @@
-require "yaml"
-require "active_support"
-require "active_record"
-require "rails/generators"
-
-module Dummy
-  class DataGenerator < Rails::Generators::Base
-    def self.source_root
-      @source_root ||= File.expand_path("../templates", __FILE__)
-    end
-    
-    class_option :base_amount, :type => :numeric, :default => 10,
-                :desc => "The base amount of records to generate for each model."
-    class_option :growth_ratio, :type => :numeric, :default => 2.0,
-                :desc => "The growth ratio of each model, according to its associations."
-    class_option :manual_amounts, :type => :boolean, :default => false,
-                :desc => "Manually set the amount of records for each model."
-    class_option :output_folder, :type => :string, :default => "test/dummy/data",
-                :desc => "Folder to use when outputting the resulting YAML files."
-
-    def install_dummy
-      initialize_application
-      generate_dummy_data
-      copy_rake_file
-    end
-
-    private
-
-    def initialize_application
-      require File.expand_path("#{Rails.root}/config/environment.rb")
-      say_status :successful, "initialize Rails application"
-    end
-
-    def generate_dummy_data
-      get_table_names
-      gather_associations
-      predict_record_amounts
-      generate_and_write_data
-    end
-
-    def get_table_names
-      @models = Hash.new
-      Dir["app/models/*.rb"].each do |full_path|
-        model = File.basename(full_path).chomp(File.extname(full_path)).camelcase.constantize
-        @models.merge!({model => {
-          :record_amount => 0, :associations => []
-        }}) if model.respond_to?(:columns)
-      end
-    end
-
-    def gather_associations
-      @models.each_key do |model|
-        model_symbol = model.to_s.underscore.pluralize.to_sym
-        associations = model.reflect_on_all_associations(:belongs_to)
-        
-        associations.each do |assoc|
-          assoc_name = assoc.name.to_s.camelcase
-          assoc_options = assoc.options
-
-          if assoc_options.empty?
-            @models[model][:associations].push({
-              :model  => assoc_name.constantize,
-              :foreign_key => "#{assoc_name.underscore}_id"
-            })
-          elsif assoc_options.has_key?(:class_name) and assoc_options.has_key?(:foreign_key)
-            @models[model][:associations].push({
-              :model => assoc_options[:class_name].constantize, # TODO: handle class_name
-              :foreign_key => assoc_options[:foreign_key]
-            })
-          else
-            next
-          end
-
-          assoc_model = @models[model][:associations].last[:model]
-          assoc_reflections = assoc_model.reflect_on_all_associations(:has_one)
-          @models[model][:associations].pop if assoc_reflections.map(&:name).include?(model_symbol)
-        end
-      end
-    end
-
-    def predict_record_amounts
-      models = @models.dup
-      models.each do |model, info|
-        predict_record_amount(model, info, models, [])
-      end
-    end
-
-    def predict_record_amount(model, info, models, stacked_models)
-      info[:associations].each do |assoc|
-        next if stacked_models.include?(assoc[:model])
-
-        if model != assoc[:model]
-          stacked_models << assoc[:model]
-          predict_record_amount(assoc[:model], @models[assoc[:model]], models, stacked_models)
-        end
-      end
-
-      amount = options.base_amount
-      if not info[:associations].empty?
-        amount = info[:associations].map do |assoc|
-          @models[assoc[:model]][:record_amount]
-        end.max*options.growth_ratio # **info[:associations].size
-      end
-      
-      if options.manual_amounts
-        user_defined = ask("Number of records for #{model} (default: #{amount}): ")
-        amount = user_defined unless user_defined.empty?
-      end
-
-      @models[model][:record_amount] = amount.to_i
-      stacked_models.delete(model)
-      models.delete(model)
-    end
-
-    def generate_and_write_data
-      empty_directory options.output_folder
-      data = Hash.new
-
-      @models.each do |model, info|
-        name = model.to_s.underscore
-        
-        (0..info[:record_amount]-1).each do |num|
-          key_value = Hash.new
-          fixture_data = Hash.new
-
-          model.columns.each do |column|
-            key_value = generate_record_data(name, info, column)
-            fixture_data.merge!(key_value) unless key_value.nil?
-          end
-          
-          data[model.table_name] = Hash.new if data[model.table_name].nil?
-          data[model.table_name].merge!({ "#{name}_#{num}" => fixture_data })
-        end
-
-        say_status :successful, "generate #{info[:record_amount]} records for '#{name}'"
-      end
-      
-      data.each do |name, fixtures|
-        content = "# '#{name}' data generated automatically by dummy at #{Time.now.strftime("%H:%M %m/%d/%Y")} (#{fixtures.size} records).\n"
-        
-        content << YAML.dump(fixtures)
-        
-        create_file "#{options.output_folder}/#{name}.yml", content
-      end
-      say_status :successful, "store fixtures"
-    end
-
-    def generate_record_data(name, info, column)
-      column_name = column.name
-      if(column_name =~ /_at$/ and column.type == :datetime) or column_name == "id"
-        return
-      end
-
-      associated_model = associated_class_name(info, column_name)
-
-      if associated_model
-        val = generate_association_data(associated_model)
-        column_name.gsub!(/_id$/, "")
-	    else
-		    val = generate_regular_data(column)
-      end
-
-	    {column_name => val}
-    end
-
-    def associated_class_name(info, name)
-      info[:associations].each do |assoc|
-        return assoc[:model] if assoc[:foreign_key] == name
-      end
-      false
-    end
-
-    def generate_association_data(associated_model)
-      random_record_num = rand(@models[associated_model][:record_amount])
-	    "#{associated_model.to_s.underscore}_#{random_record_num}"
-    end
-
-    def generate_regular_data(column)
-      val = Dummy.magic_data(column.name, column.type)
-      
-      if val
-        val
-      else
-        say_status :failed, "data generation for '#{column.name}' with type '#{column.type.to_s.downcase}'", :red
-        ""
-      end
-    end
-
-    def copy_rake_file
-      template "dummy.rake", "lib/tasks/dummy.rake"
-    end
-  end
-end
-

data/lib/generators/templates/dummy.rake

@@ -1,13 +0,0 @@
-require 'active_record/fixtures'
-
-namespace :dummy do
-  namespace :data do
-    desc "Load the generated dummy data into the current environment's database."
-    task :import => :environment do
-      Fixtures.reset_cache
-      fixtures_folder = File.join(Rails.root, "<%= options.output_folder %>")
-      fixtures = Dir[File.join(fixtures_folder, '*.yml')].map {|f| File.basename(f, '.yml') }
-      Fixtures.create_fixtures(fixtures_folder, fixtures)
-    end
-  end
-end