story-helper 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2008-10-21
+
+* Released version 0.1.0 on RubyForge today.  
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/storify
+lib/story-helper.rb
+lib/story-helper/conf/story_accessors.rb
+lib/story-helper/conf/story_helper.rake
+lib/story-helper/conf/story_helper.rb
+lib/story-helper/conf/test_helper_extensions.rb
+lib/story-helper/version.rb
+story-helper.gemspec
+test/rails_version_test.rb
+test/test_story_helper.rb

data/README.txt

@@ -0,0 +1,53 @@
+= story-helper
+
+* http://github.com/jtrupiano/story-helper
+
+== DESCRIPTION:
+
+Provides very basic baseline for using direct Ruby to define your test data and test accessors.  Still a work in progress,
+but something we use at SLS in lieu of fixtures.  More details to come as this becomes more useful to others.
+
+There's some information on the wiki regarding how to use it in conjunction with fixtures.
+
+== FEATURES/PROBLEMS:
+
+* not entirely DRY (requires you to define your accessors in addition to your test data -- this should be able to be automated)
+* could auto-convert existing fixtures
+* should only be used in conjunction with pre-built test databases (in other words, no dropping and recreating for each test case -- use DB transactions instead)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* sudo gem install story-helper
+
+== 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/Rakefile

@@ -0,0 +1,31 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/story-helper.rb'
+require './lib/story-helper/version'
+
+PKG_NAME      = "story-helper"
+PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+version = StoryHelper::Version::STRING.dup
+if ENV['SNAPSHOT'].to_i == 1
+  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+end
+PKG_VERSION   = version
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+Hoe.new(PKG_NAME, PKG_VERSION) do |p|
+  p.rubyforge_name = 'johntrupiano' # if different than lowercase project name
+  p.developer('John Trupiano', 'jtrupiano@gmail.com')
+  p.name = PKG_NAME
+  p.version = PKG_VERSION
+  #p.platform = Gem::Platform::RUBY
+  p.description = %q(A set of helpers/features to aid in implementing the StoryHelper concept in rails apps)
+  p.summary = p.description # More details later??
+  p.remote_rdoc_dir = PKG_NAME # Release to /PKG_NAME
+  #  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
+  p.need_zip = true
+  p.need_tar = false
+end
+
+# vim: syntax=Ruby

data/bin/storify

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# storify
+# Author: John Trupiano
+#
+# Steps
+# 1) Check if lib/story_helper.rb exists-- if not, let's place it in there
+# 2) Check if lib/story_accessors.rb exists-- if not, let's place it in there
+# 3) Check if lib/tasks/story_helper.rake exists-- if not, let's place it in there
+# 4) Tell them to update their test_helper.rb file
+#
+# 5) How else can we help the user out?  
+#    Can we auto-convert their fixtures?  
+#    How about creating default StoryAccessors sections for each model?
+#    What else??
+
+require 'fileutils'
+include FileUtils
+
+#require 'yaml'
+
+class Storify
+  
+  def self.run!
+    rails_root = ARGV[0] || '.'
+    puts "rails_root: #{rails_root}"
+    
+    # lib/story_helper.rb
+    story_helper_rb = File.join(rails_root, 'lib', 'story_helper.rb')
+    gem_story_helper_rb = File.dirname(__FILE__) + '/../lib/story-helper/conf/story_helper.rb'
+    copy_if_missing(gem_story_helper_rb, story_helper_rb)
+
+    # lib/story_accessors.rb
+    story_accessors_rb = File.join(rails_root, 'lib', 'story_accessors.rb')
+    gem_story_accessors_rb = File.dirname(__FILE__) + '/../lib/story-helper/conf/story_accessors.rb'
+    copy_if_missing(gem_story_accessors_rb, story_accessors_rb)
+
+    # lib/tasks/story_helper.rake
+    story_helper_rake = File.join(rails_root, 'lib', 'tasks', 'story_helper.rake')
+    gem_story_helper_rake = File.dirname(__FILE__) + '/../lib/story-helper/conf/story_helper.rake'
+    copy_if_missing(gem_story_helper_rake, story_helper_rake)
+  end
+  
+  def self.cleanup!
+    rails_root = ARGV[0] || '.'
+    puts "rails_root: #{rails_root}"
+    
+    # lib/story_helper.rb
+    story_helper_rb = File.join(rails_root, 'lib', 'story_helper.rb')
+    delete_unless_missing(story_helper_rb)
+
+    # lib/story_accessors.rb
+    story_accessors_rb = File.join(rails_root, 'lib', 'story_accessors.rb')
+    delete_unless_missing(story_accessors_rb)
+
+    # lib/tasks/story_helper.rake
+    story_helper_rake = File.join(rails_root, 'lib', 'tasks', 'story_helper.rake')
+    delete_unless_missing(story_helper_rake)
+  end
+  
+  private
+    def self.copy_if_missing(from, to)
+      if !File.exists?(to)
+        puts "cp #{from} #{to}"
+        cp(from, to)
+      else
+        puts "#{to} already exists"
+      end
+    end
+    
+    def self.delete_unless_missing(file)
+      if File.exists?(file)
+        cmd = "rm #{file}"
+        puts cmd
+        rm_f(file)
+      else
+        puts "Deleting #{file}....doesn't exist."
+      end
+    end
+    
+end
+
+if ARGV.size > 1 && ARGV[1] == "cleanup"
+  Storify.cleanup!
+else
+  Storify.run!
+  puts "Don't forget to include StoryAccessors::Methods into your test_helper."
+end

data/lib/story-helper/conf/story_accessors.rb

@@ -0,0 +1,38 @@
+# Defines a basic cached accessor
+def meta_accessor(accessor, klass, find_by_field="name", field_value=accessor)
+  src = <<-RUBY
+    def #{accessor}(reload=false)
+      return @#{accessor} if @#{accessor} && !reload
+      @#{accessor} = #{klass.to_s}.find_by_#{find_by_field}("#{field_value}")
+    end
+  RUBY
+  class_eval src, __FILE__, __LINE__
+end
+
+# Generalized accessor functor
+def scoped_meta_accessor(model_str, key, value, scoped_type, scoped_type_id, default_accessor_str)
+  scoped_field = "#{scoped_type}_id"
+  src = <<-RUBY
+    def #{key}(#{scoped_type}=#{default_accessor_str}, reload=false)
+      key = "@#{key}_" + #{scoped_type}.#{scoped_type_id}.to_s.gsub(' ', '_')
+      if reload || !instance_variable_defined?(key.to_sym)
+        instance_variable_set(key.to_sym, #{model_str}.find_by_name_and_#{scoped_field}(%q(#{value}), #{scoped_type}.id))
+      end
+      instance_variable_get(key.to_sym)
+    end
+  RUBY
+  class_eval src, __FILE__, __LINE__
+end
+
+module StoryAccessors
+  
+  module Methods
+
+    ####### Accounts #######
+    # %w(amy sarah joanne julia erin).each do |acct|
+    #   meta_accessor(acct.to_s, Account, "login")
+    # end
+    
+  end
+  
+end

data/lib/story-helper/conf/story_helper.rake

@@ -0,0 +1,44 @@
+#############################
+# Rewrites the test tasks to enforce StoryHelper usage
+#############################
+
+namespace :db do
+  desc "Load dev data into the current environment's database."
+  task :load_stories => :environment do
+    StoryHelper.purge_all_data
+    # Rake::Task['db:fixtures:load'].invoke
+    StoryHelper.load_all
+  end  
+end
+
+# First, delete the Tasks we wish to override
+["functionals", "units", "integrations", "all"].each do |tt|
+  Rake.application.send(:eval, "@tasks.delete('test:#{tt}')")
+end
+
+# Now, override them!
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = true
+  end
+  Rake::Task['test:units'].comment = "*StoryHelper: Run the unit tests in test/unit.  Your test data MUST be preloaded into the database."
+
+  Rake::TestTask.new(:functionals) do |t|
+    t.libs << "test"
+    t.pattern = 'test/functional/**/*_test.rb'
+    t.verbose = true
+  end
+  Rake::Task['test:functionals'].comment = "StoryHelper: Run the functional tests in test/functional.  Your test data MUST be preloaded into the database."
+  
+  Rake::TestTask.new(:integrations) do |t|
+    t.libs << "test"
+    t.pattern = 'test/integration/**/*_test.rb'
+    t.verbose = true
+  end
+  Rake::Task['test:integrations'].comment = "StoryHelper: Run the integration tests in test/integration.  Your test data MUST be preloaded into the database."
+  
+  desc "StoryHelper: Run unit and functional tests.  Your test data MUST be preloaded into the database."
+  task :all => [:units, :functionals, :integrations]
+end

data/lib/story-helper/conf/story_helper.rb

@@ -0,0 +1,17 @@
+# Exposes methods that create dev and test data. Loads things from a "user story"
+# perspective.
+class StoryHelper
+  self.extend StoryAccessors::Methods
+
+  def self.load_all
+    # Load data via Ruby -- your models are accessible here, so use those functions to create complex data!
+    #self.load_all
+  end
+  
+  # 
+  def self.purge_all_data
+    # Manually delete from all models and non-model join tables
+    #self.purge_all_data
+  end
+  
+end

data/lib/story-helper/conf/test_helper_extensions.rb

@@ -0,0 +1,44 @@
+class ActionController::TestCase
+  extend StoryAccessors::Methods  # this probably isn't the right thing to do....
+  
+  # allows us to use the self.log_in function to log in a certain user
+  @@scoped_session = {}
+  
+  # Used as a directive at the top of a functional test (to blanket log in this user)
+  # def self.log_in(user)
+  #     #puts "logging in #{user.email}"
+  #     @@scoped_session.merge!({:user_id => user.id})
+  #   end
+  
+  # invoke in setup (or within a specific test to override the setup method)
+  def log_in(user)
+    @@scoped_session[:user_id] = user.id
+  end
+  
+  def log_out
+    @@scoped_session.delete(:user_id)
+  end
+  
+  # Used within a test to log in a specific user for a single test
+  # def log_in(user)
+  #     old_user_id = @@scoped_session[:user_id]
+  #     @@scoped_session[:user_id] = user.id
+  #     yield
+  #   ensure
+  #     @@scoped_session[:user_id] = old_user_id
+  #   end
+  
+  [:get, :post, :put, :delete].each do |meth|
+    src = <<-END_OF_SRC
+      def #{meth.to_s}(action, parameters = nil, session = {}, flash = nil)
+        super(action, parameters, session.merge(@@scoped_session || {}), flash)
+      end
+    END_OF_SRC
+    class_eval src, __FILE__, __LINE__
+  end
+
+  def xhr(request_method, action, parameters = nil, session = {}, flash = nil)
+    super(request_method, action, parameters, session.merge(@@scoped_session || {}), flash)
+  end
+  
+end

data/lib/story-helper/version.rb

@@ -0,0 +1,20 @@
+module StoryHelper
+  module Version #:nodoc:
+    # A method for comparing versions of required modules. It expects two
+    # arrays of integers as parameters, the first being the minimum version
+    # required, and the second being the actual version available. It returns
+    # true if the actual version is at least equal to the required version.
+    def self.check(required, actual) #:nodoc:
+      required = required.map { |v| "%06d" % v }.join(".")
+      actual   = actual.map { |v| "%06d" % v }.join(".")
+      return actual >= required
+    end
+
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join(".")
+  end
+end
+

data/story-helper.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+  s.name = %q{story-helper}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Trupiano"]
+  s.date = %q{2008-09-16}
+  s.default_executable = %q{storify}
+  s.description = %q{A set of helpers/features to aid in implementing the StoryHelper concept in rails apps}
+  s.email = ["jtrupiano@gmail.com"]
+  s.executables = ["storify"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/storify", "lib/story-helper.rb", "lib/story-helper/conf/story_accessors.rb", "lib/story-helper/conf/story_helper.rake", "lib/story-helper/conf/story_helper.rb", "lib/story-helper/version.rb", "story-helper.gemspec", "test/rails_version_test.rb", "test/test_story_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/jtrupiano/story-helper}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{johntrupiano}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{A set of helpers/features to aid in implementing the StoryHelper concept in rails apps}
+  s.test_files = ["test/test_story_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+  end
+end

data/test/rails_version_test.rb

@@ -0,0 +1,38 @@
+require 'test/unit'
+require 'fileutils'
+require 'yaml'
+
+class RailsVersionTest < Test::Unit::TestCase
+  include FileUtils
+  
+  def test_rails_two_one_one
+    # Clean up an old run if necessary
+    rm_rf('rails211test')
+    
+    cp_r('rails211', 'rails211test')
+    system("storify rails211test")
+    
+    # config_root = File.join('rails211test', 'config')
+    # 
+    # assert File.exists?(File.join(config_root, 'postboot.rb'))
+    # 
+    # env_rb = File.open(File.join(config_root, 'environment.rb')).read
+    # assert env_rb.include?("require File.join(File.dirname(__FILE__), 'postboot')")
+    # 
+    # %w(development test demo staging production).each do |env|
+    #   assert File.directory?(File.join(config_root, env))
+    # end
+    # 
+    # %w(development test production).each do |env|
+    #   %w(database.yml environment.rb).each do |f|
+    #      assert File.exists?(File.join(config_root, env, f))
+    #    end
+    #    puts "Testing #{env}"
+    #    y = YAML.load_file(File.join(config_root, env, 'database.yml'))
+    #    assert_equal 1, y.keys.size
+    #    assert_equal env, y.keys.first
+    # end
+#  ensure
+#    rm_rf('rails210test')
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: story-helper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Trupiano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: A set of helpers/features to aid in implementing the StoryHelper concept in rails apps
+email: 
+- jtrupiano@gmail.com
+executables: 
+- storify
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/storify
+- lib/story-helper.rb
+- lib/story-helper/conf/story_accessors.rb
+- lib/story-helper/conf/story_helper.rake
+- lib/story-helper/conf/story_helper.rb
+- lib/story-helper/conf/test_helper_extensions.rb
+- lib/story-helper/version.rb
+- story-helper.gemspec
+- test/rails_version_test.rb
+- test/test_story_helper.rb
+has_rdoc: true
+homepage: http://github.com/jtrupiano/story-helper
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: johntrupiano
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A set of helpers/features to aid in implementing the StoryHelper concept in rails apps
+test_files: 
+- test/test_story_helper.rb