fixture_generator 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+nbproject

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fixture_generator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+Fixture Generator
+=============
+
+`fixture_generator` gem can be used to manage fixtures by generating them using Rails code.
+
+Installation
+------------
+
+    gem install fixture_generator
+
+Usage
+-----
+
+  class MyFixtureGenerator < FixtureGenerator
+    def populate
+      # Create your records here and add them to the fixture set by calling
+      # 'add_record(record_name, record_object)'. That's it!
+    end
+  end
+
+  rake fixtures:generate GENERATOR="MyFixtureGenerator"
+
+Author
+------
+
+B V Satyaram <[bvsatyaram.com](http://bvsatyaram.com)>
+Inspired by back mark plugin authored by Vikram Venkatesan

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+
+namespace :fixtures do
+  desc "Generates test fixture files"
+  task :generate => :environment do
+    # Work with test db.
+    RAILS_ENV = ENV['RAILS_ENV'] = "test"
+
+    # Clean the database first.
+    puts "*** FixturePopulator :: Cleaning the database"
+    Rake::Task["cleandbtest"].invoke
+
+    print "*** FixturePopulator :: Generating data"
+    # Replace the following line with the fixture generator class of your project.
+    eval ENV['GENERATOR'] + ".generate"
+
+    puts "\nDone"
+  end
+end

data/fixture_generator.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fixture_generator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fixture_generator"
+  s.version     = FixtureGenerator::VERSION
+  s.authors     = ["Satyaram B V"]
+  s.email       = ["bvsatyaram@gmail.com"]
+  s.homepage    = "http://www.bvsatyaram.com/"
+  s.summary     = %q{Manage fixtures by generating them using Rails code}
+  s.description = %q{Manage fixtures by generating them using Rails code}
+
+  s.rubyforge_project = "fixture_generator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/fixture_generator.rb

@@ -0,0 +1,172 @@
+require "fixture_generator/version"
+
+# Provides the functionality for creating active record objects and associating
+# fixture names to them and then writing them to yml files.
+
+class FixtureGenerator
+  # Map from model class name to the corresponding table name.
+  attr_accessor :models
+
+  # Map from each table name to fixtures for that table name.
+  #
+  #   {
+  #    'users' => {:greg => <object>, :mark => <object>},
+  #    'cars'  => {:benz => <object>, :ferrari => <object>}
+  #   }
+  #
+  attr_accessor :object_map
+
+  # Mapping from active record object to the fixture name.
+  attr_accessor :fixture_name_map
+
+  # Generates fixture data and writes them to yml files.
+  #
+  def self.generate(opts = {})
+    _generator = self.new
+
+    # Register the models.
+    (ActiveRecord::Base.send(:subclasses) - (opts[:except] || [])).each do |model_klass|
+      _generator.register_model(model_klass)
+    end
+
+    ActiveRecord::Base.transaction do
+      ActiveRecord::Base.connection.execute "SET AUTOCOMMIT=0;"
+      begin
+        _generator.populate
+      end
+      ActiveRecord::Base.connection.execute "SET AUTOCOMMIT=1;"
+    end
+
+    _generator.write_to_file
+  end
+
+  # Creates the ActiveRecord records to be written to yml files.
+  #
+  # To be implemented by the project specific generator.
+  #
+  def populate
+    raise NotImplementedError
+  end
+
+  # Registers the model with class name +klass+ and corresponding table name
+  # +table_name+
+  #
+  def register_model(klass)
+    table_name = klass.table_name
+    self.models[klass] = table_name
+    self.object_map[table_name] = {}
+
+    self.class_eval do
+      # Define accessors for the fixtures for this new model.
+      define_method(table_name) do |name|
+        self.object_map[table_name][name.to_sym]
+      end
+    end
+  end
+
+  # Writes the generated fixture records to files under 'fixtures' directory.
+  #
+  # XXX Note that any existing fixtures will be replaced with the new ones by
+  # this method.
+  #
+  def write_to_file
+    newline
+    say "Writing fixtures to YAML files"
+    records_by_table_name = {}
+
+    self.models.each do |model_class, table_name|
+      # Load all records of this model.
+      records_by_table_name[table_name] ||= []
+      records_by_table_name[table_name] += model_class.all
+    end
+
+    records_by_table_name.each do |table_name, records|
+      yaml_data = ""
+
+      if records.any?
+        # Sequence number for records for which we do not have names.
+        i = "0"
+        data_array = []
+
+        records.uniq.each do |record|
+          # Get the name given for this record while populating. If not
+          # available (autogenerated through callbacks), use a sequence number
+          # prefixed by the table name.
+          fixture_name = self.fixture_name_map[record] || "#{table_name}_#{i.succ!}"
+          attrs = record.attributes
+          attrs['delta'] = false if attrs.key?('delta')
+          data_array << {fixture_name => attrs}.to_yaml.gsub(/--- \n/, "")
+        end
+
+        yaml_data = data_array.join("\n")
+
+        File.open("#{RAILS_ROOT}/test/fixtures/#{table_name}.yml", "w") do |file|
+          file.write yaml_data
+        end
+      end
+      dot
+    end
+  end
+
+  private
+
+  # Private constructor for providing a static interface to the generator.
+  #
+  def initialize
+    self.models = {}
+    self.object_map = {}
+    self.fixture_name_map = {}
+
+    # Lower the logging level since we are about to create many records.
+    _logger                   = Logger.new(STDOUT)
+    _logger.level             = Logger::ERROR
+    ActiveRecord::Base.logger = _logger
+  end
+
+  # Adds a fixture +record+ with the given +name+.
+  #
+  def add_record(name, record)
+    klass_map = self.object_map[self.models[record.class]]
+
+    # Panic if attempted to insert duplicate fixture record.
+    if klass_map.include?(name.to_sym)
+      raise "Duplicate fixture for #{record.class} - #{name}"
+    end
+
+    self.fixture_name_map[record] = name.to_s
+    klass_map[name.to_sym] = record
+    dot
+
+    return record
+  end
+
+  ##############################################################################
+  # PRINTING
+  ##############################################################################
+
+  def say(str)
+    print "*** FixtureGenerator :: #{str}"
+  end
+
+  def say_populating(model_name)
+    newline
+    say "Populating #{model_name}"
+  end
+
+  def warn(msg)
+    print_and_flush "!!! WARNING: #{msg}\n"
+  end
+
+  def dot
+    print_and_flush(".")
+  end
+
+  def newline
+    print_and_flush("\n")
+  end
+
+  def print_and_flush(msg)
+    print msg
+    $stdout.flush
+  end
+end

data/lib/fixture_generator/version.rb

@@ -0,0 +1,3 @@
+module FixtureGenerator
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: fixture_generator
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Satyaram B V
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-26 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: Manage fixtures by generating them using Rails code
+email: 
+- bvsatyaram@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- fixture_generator.gemspec
+- lib/fixture_generator.rb
+- lib/fixture_generator/version.rb
+has_rdoc: true
+homepage: http://www.bvsatyaram.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: fixture_generator
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Manage fixtures by generating them using Rails code
+test_files: []
+