harvixture 0.8.0

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jeremy Friesen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,50 @@
+= harvixture
+
+* FIX (url)
+
+== DESCRIPTION:
+
+Harvixture is a tool that can be used to extract data, in the form of fixtures,
+from a Rails project.  It is done by pointing the harvixture at a request_path
+and dumping fixtures for all "found" ActiveRecord objects.
+
+== SYNOPSIS:
+
+$ cd path/to/rails/project
+$ . harvixture run --request_path=/calendars/1 --output_dir=./bug_100 --rails_env=production
+./bug_100/users.yml
+./bug_100/calendars.yml
+
+== REQUIREMENTS:
+
+gem main, activerecord, mocha (for tests)
+a Rails project
+
+== INSTALL:
+
+sudo gem install harvixture
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/harvixture

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+require 'date'
+require 'rubygems'
+require 'harvixture'
+gem 'harvixture'
+require 'harvixture/command'
+gem 'main'
+require 'main'
+
+Main {
+  description <<-txt
+    Harvixture is a tool to help you capture fixtures from a system
+  txt
+
+  mode(:run) {
+    description <<-txt
+      Point harvixture to a URI and gather the fixtures.
+    txt
+    example <<-txt
+      ./harvixture --request_path=/calendars/1 --output_dir=./bug_100 --rails_env=production
+    txt
+    mixin :option_output_dir, :option_rails_env, :option_request_path, :option_user_id, :option_rails_root
+    run { 
+      Harvixture::Command.process!(
+        :rails_root => rails_root, 
+        :output_dir => output_dir, 
+        :request_path => request_path,  
+        :rails_env => rails_env, 
+        :user_id => user_id
+      )
+    }
+  }
+
+  mixin :option_rails_root do
+    option(:r, :rails_root){
+      required
+      defaults './'
+      argument :required
+      desc 'path to rails root'
+      attr
+    }
+  end
+  mixin :option_output_dir do
+    option(:o,:output_dir){
+      required
+      defaults "./test/fixtures/scenario_for_#{Date.today.strftime('%Y_%m_%d')}"
+      argument :required
+      desc 'directory name where fixtures will be written'
+      attr
+    }
+  end
+
+  mixin :option_rails_env do
+    option(:e,:rails_env){
+      required
+      defaults 'production'
+      argument :required
+      desc 'script/server environment to use'
+      attr
+    }
+  end
+
+  mixin :option_request_path do
+    option(:p,:request_path){
+      required
+      argument :required
+      desc 'path to request from the script/server'
+      attr
+    }
+  end
+
+  mixin :option_user_id do
+    option(:u,:user_id){
+      argument :optional
+      desc 'authenticate with user_id'
+      attr
+    }
+  end
+
+  run{ help! }
+}
+

data/lib/harvixture.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Harvixture
+  
+end
+require 'rubygems'
+require 'activerecord'
+require 'harvixture/config'
+require 'harvixture/active_record_extension'
+require 'harvixture/command'
+require 'harvixture/model'
+require 'harvixture/preparer'

data/lib/harvixture/active_record_extension.rb

@@ -0,0 +1,37 @@
+module Harvixture
+  module ActiveRecordExtension
+    def after_find
+      harvixture_model.write_fixture
+    end
+    def to_harvixture
+      lines = attributes.to_yaml.split("\n")
+      lines.shift
+      "\n#{self.class.table_name}_#{self.id}:\n  "  +  lines.join("\n  ")
+    end
+    
+    protected
+    def harvixture_model
+      @harvixture_model ||= Harvixture::Model.new(self)
+    end
+    
+  end
+end
+
+ActiveRecord::Base.send(:include, Harvixture::ActiveRecordExtension) unless ActiveRecord::Base.included_modules.include?(Harvixture::ActiveRecordExtension)
+
+class << ActiveRecord::Base
+  # Oh the trickery!
+  def method_added(method_name)
+    return true if @__adjusting_after_find
+    super
+    if method_name == :after_find 
+      @__adjusting_after_find = true
+      after_find_method = self.instance_method(:after_find)
+      define_method(:after_find) do
+        super
+        after_find_method.bind(self).call
+      end
+      @__adjusting_after_find = false
+    end
+  end
+end

data/lib/harvixture/command.rb

@@ -0,0 +1,37 @@
+require 'open-uri'
+module Harvixture
+  module Command
+    class << self
+      # :rails_root
+      # :output_dir
+      # :request_path
+      # :rails_env
+      # :user_id
+      def process!(options={})
+        process = nil
+        Preparer.do_it!(options[:rails_root])
+        Config.update(options)
+        process = Process.fork do
+          Signal.trap('HUP') { exit }
+          stdin = open '/dev/null', 'r'
+          stdout = open '/dev/null', 'w'
+          stderr = open '/dev/null', 'w'
+          STDIN.reopen stdin
+          STDOUT.reopen stdout
+          STDERR.reopen stderr
+          exec %(ruby script/server -e harvixture -p 8675)
+        end
+        # Wait for the script server to reload
+        sleep(5)
+        open(File.join('http://localhost:8675', Config.request_path))
+      rescue Exception => e
+        puts e
+        puts e.backtrace
+      ensure
+        Process.kill('HUP', process) if process
+        Process.wait
+        Process.exit!
+      end
+    end
+  end
+end

data/lib/harvixture/config.rb

@@ -0,0 +1,59 @@
+module Harvixture
+  class Config
+    class << self
+      def rails_env
+        values['rails_env']
+      end
+      def request_path
+        values['request_path']
+      end
+      def output_dir
+        values['output_dir']
+      end
+      def user_id
+        values['user_id']
+      end
+
+      def update(attributes = {})
+        new_values = {
+          'output_dir' => attributes[:output_dir] || attributes['output_dir'] || output_dir,
+          'rails_env' => attributes[:rails_env] || attributes['rails_env'] || rails_env,
+          'request_path' => attributes[:request_path] || attributes['request_path'] || request_path,
+          'user_id' => attributes[:user_id] || attributes['user_id'] || user_id,
+        }
+        File.open(filename, 'w+') {|f| f.puts YAML.dump(new_values)}
+        Dir.glob(File.join(output_dir, '*.yml')).each {|f| File.delete(f) if File.exist?(f)}
+        @values = nil
+        values
+      end
+      
+      def filename
+        File.join(home, '.harvixture_config.yml')
+      end
+      
+      protected
+      def home
+        ENV['HOME'] || ENV['USERPROFILE'] || ENV['HOMEPATH']
+      end
+      def values
+        return @values if @values
+        begin
+          @values = YAML::load(open(filename)) || write_template
+        rescue
+          @values = write_template
+        end
+
+        @values
+      end
+      
+      def write_template
+        open(filename,'w').write(template)
+        YAML::load open(filename)        
+      end
+      
+      def template
+        %(---\n  output_dir: ./test/fixtures/harvixture_scenario\n  user_id: \n  rails_env: production\n  request_path: )
+      end
+    end
+  end
+end

data/lib/harvixture/model.rb

@@ -0,0 +1,21 @@
+require 'fileutils'
+module Harvixture
+  class Model
+    attr_reader :object
+    def initialize(object)
+      @object = object
+    end
+    
+    def write_fixture
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.open(filename, 'w+') { |file| file.print '---' } unless File.exist?(filename)
+      File.open(filename, 'a+') do |file|
+        file.puts object.to_harvixture
+      end
+    end
+    
+    def filename
+      File.join(RAILS_ROOT, Config.output_dir, "#{object.class.table_name}.yml")
+    end
+  end
+end

data/lib/harvixture/preparer.rb

@@ -0,0 +1,39 @@
+module Harvixture
+  class Preparer
+    class << self
+
+      # Install the necessary files on the rails project
+      def do_it!(rails_root)
+        self.new(rails_root)
+      end
+    end
+    attr_reader :rails_root
+    def initialize(rails_root)
+      @rails_root = rails_root
+      create_environment_harvixture
+      update_database_yml
+    end
+
+    protected
+
+    def create_environment_harvixture
+      filename = File.join(rails_root, 'config', 'environments', 'harvixture.rb')
+      return if File.exist?(filename)
+      File.open(filename, 'w+') do |file|
+        file.puts '#START DO NOT MODIFY'
+        file.puts 'require "harvixture"'
+        file.puts '"#{File.read(File.join(File.dirname(__FILE__), "#{Harvixture::Config.rails_env}.rb"))}"'
+        file.puts '#END DO NOT MODIFY'
+      end
+    end
+    def update_database_yml
+      config = File.read(File.join(rails_root, 'config', 'database.yml'))
+      return if config.match(/^harvixture:/)
+      puts 'updating database.yml'
+      config.gsub!(/^(\w*): *$/, '\1: &\1')
+      File.open(File.join(rails_root, 'config', 'database.yml'), 'w+') do |file|
+        file.puts "#{config}\n\nharvixture:\n  <<: *<%= Harvixture::Config.rails_env rescue 'production' %>"
+      end
+    end
+  end
+end

data/test/test_harvixture_active_record_extension.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/test_helper'
+class Harvixture::ActiveRecordExtensionTest < Test::Unit::TestCase
+  class AbstractUnit < ActiveRecord::Base
+    def self.columns; []; end
+    def attributes
+      {'name' => 'my name', 'id' => id }
+    end
+    def id; 8675309; end
+  end
+
+  class AbstractUnitWithAfterFind < AbstractUnit
+    def after_find
+      @after_find_called = true
+    end
+    def after_find_called?
+      @after_find_called
+    end
+  end
+
+  def test_after_find_with_inheritance
+    abstract_unit = AbstractUnitWithAfterFind.new
+    abstract_unit.send(:harvixture_model).expects(:write_fixture)
+    abstract_unit.after_find
+  end
+
+  def test_after_find_with_inheritance_calls_defined_inheritance_model
+    abstract_unit = AbstractUnitWithAfterFind.new
+    abstract_unit.send(:harvixture_model).stubs(:write_fixture)
+    abstract_unit.after_find
+    assert abstract_unit.after_find_called?
+  end
+
+  def test_after_find_should_write_to_the_harvixture_model
+    abstract_unit = AbstractUnit.new
+    abstract_unit.send(:harvixture_model).expects(:write_fixture).returns(:expected_value)
+    abstract_unit.after_find
+  end
+
+  def test_to_harvixture
+    abstract_unit = AbstractUnit.new
+    assert_equal abstract_unit.to_harvixture, "\nabstract_units_8675309:\n  name: my name\n  id: 8675309"
+  end
+end

data/test/test_harvixture_model.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Harvixture::ModelTest < Test::Unit::TestCase
+  class AbstractModel
+    class << self
+      def table_name
+        'abstract_models'
+      end
+    end
+    def to_harvixture
+      %(
+abstract_model_1:
+  name: hello)
+    end
+  end
+  def test_fixtures
+    @harvixture_model = Harvixture::Model.new(mock_model)
+    def @harvixture_model.filename
+      File.join(File.dirname(__FILE__), 'tmp.yml')
+    end
+    @harvixture_model.write_fixture
+    assert YAML.load(File.read(@harvixture_model.filename))['abstract_model_1']
+  ensure
+    FIle.delete(File.dirname(__FILE__), 'tmp.yml') rescue true
+  end
+  
+  def mock_model
+    @abstract_model ||= AbstractModel.new
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/harvixture'
+require 'mocha'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: harvixture
+version: !ruby/object:Gem::Version 
+  version: 0.8.0
+platform: ruby
+authors: 
+- Jeremy Friesen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: main
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.6
+    version: 
+description: Harvixture is a tool that can be used to extract data, in the form of fixtures, from a Rails project.  It is done by pointing the harvixture at a request_path and dumping fixtures for all "found" ActiveRecord objects.
+email: jeremyf@lightsky.com
+executables: 
+- harvixture
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/harvixture/active_record_extension.rb
+- lib/harvixture/command.rb
+- lib/harvixture/config.rb
+- lib/harvixture/model.rb
+- lib/harvixture/preparer.rb
+- lib/harvixture.rb
+- bin/harvixture
+- test/test_harvixture_active_record_extension.rb
+- test/test_harvixture_model.rb
+- test/test_helper.rb
+- README
+- License.txt
+has_rdoc: true
+homepage: http://github.com/jeremyf/harvixture
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A tool for harvesting fixtures from production data
+test_files: 
+- test/test_harvixture_active_record_extension.rb
+- test/test_harvixture_model.rb
+- test/test_helper.rb