jtrupiano-story-helper 0.1.0 → 0.2.0

data/History.txt

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

data/Manifest.txt

@@ -1,12 +1,13 @@
 History.txt
 Manifest.txt
-README.txt
+README.textile
 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

data/{README.txt → README.textile}

@@ -1,28 +1,38 @@
-= story-helper
+h1. story-helper
 
-* http://github.com/jtrupiano/story-helper
+p. http://github.com/jtrupiano/story-helper
 
-== DESCRIPTION:
+h2. DESCRIPTION
 
-FIX (describe your package)
+p. 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.
 
-== FEATURES/PROBLEMS:
+p. There's some information on the wiki regarding how to use it in conjunction with fixtures.
 
-* FIX (list of features or problems)
+h2. FEATURES/PROBLEMS
 
-== SYNOPSIS:
+* 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)
 
-  FIX (code sample of usage)
+h2. SYNOPSIS
 
-== REQUIREMENTS:
+from RAILS_ROOT
+* storify .
+
+Implement StoryHelper#purge_all_data and StoryHelper#load_all in lib/story_helper.rb
+* rake db:stories:load RAILS_ENV=____
+
+h2. REQUIREMENTS
 
 * FIX (list of requirements)
 
-== INSTALL:
+h2. INSTALL
 
-* FIX (sudo gem install, anything else)
+* sudo gem install story-helper (stable version from RubyForge)
+* sudo gem install jtrupiano-story-helper (HEAD of the repo from github)
 
-== LICENSE:
+h2. LICENSE
 
 (The MIT License)
 

data/bin/storify

@@ -23,28 +23,43 @@ class Storify
   def self.run!
     rails_root = ARGV[0] || '.'
     puts "rails_root: #{rails_root}"
-    config_base = File.join(rails_root, 'config')
-    old_env_dir = File.join(config_base, 'environments')
-
+    
     # lib/story_helper.rb
     story_helper_rb = File.join(rails_root, 'lib', 'story_helper.rb')
-    gem_story_helper_rb = File.dirname(__FILE__) + '/../lib/conf/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/conf/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/conf/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?(from)
+      if !File.exists?(to)
         puts "cp #{from} #{to}"
         cp(from, to)
       else
@@ -52,7 +67,21 @@ class Storify
       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
 
-Storify.run!
-puts "Don't forget to include StoryAccessors::Methods into your test_helper."
+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

@@ -1,20 +1,3 @@
-    
-module StoryAccessors
-  
-  module Methods
-
-    ####### Accounts #######
-    # %w(amy sarah joanne julia erin).each do |acct|
-    #   meta_accessor(acct.to_s, Account, "login")
-    # end
-    
-
-  end
-  
-end
-
-
-
 # Defines a basic cached accessor
 def meta_accessor(accessor, klass, find_by_field="name", field_value=accessor)
   src = <<-RUBY
@@ -40,3 +23,16 @@ def scoped_meta_accessor(model_str, key, value, scoped_type, scoped_type_id, def
   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

@@ -3,11 +3,47 @@
 #############################
 
 namespace :db do
-  desc "Load dev data into the current environment's database."
-  task :load_stories => :environment do
-    StoryHelper.purge_all_data
-    StoryHelper.load_all
-  end  
+  desc "Refresh all the stories"
+  task :stories => [:environment, "stories:purge", "stories:load"]
+  
+  namespace :stories do
+    
+    desc "Load the stories"
+    task :load => [:environment, "seed:load", "data:load"]
+    
+    desc "Purge the stories"
+    task :purge => [:environment, "data:purge", "seed:purge"]
+    
+    desc "Refresh to seed data"
+    task :seed => [:environment, "data:purge", "seed:purge", "seed:load"]
+    
+    desc "Refresh to test data"
+    task :data => [:environment, "data:purge", "data:load"]
+  
+    namespace :seed do
+      desc "Load Seed Data"
+      task :load => [:environment] do
+        StoryHelper.load_seed
+      end
+      
+      desc "Purge Seed Data"
+      task :purge => [:environment] do
+        StoryHelper.purge_seed
+      end      
+    end
+    
+    namespace :data do
+      desc "Load test data"
+      task :load => [:environment] do
+        StoryHelper.load_data
+      end
+
+      desc "Purge test data"
+      task :purge => [:environment] do
+        StoryHelper.purge_data
+      end
+    end
+  end
 end
 
 # First, delete the Tasks we wish to override

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

@@ -3,15 +3,53 @@
 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!
+  # load up the seed data for your application. This is data that should be loaded when the
+  # application is deployed to a server for the first time. For example, an Admin account and
+  # models like FileType that are database-level constants.
+  #
+  # This is best run as a series of calls to private methods:
+  #   self.load_people
+  #   self.load_posts
+  # etc...
+  def self.load_seed
   
   end
   
-  # 
-  def self.purge_all_data
-    # Manually delete from all models and non-model join tables
-    
+  # Purge the seed data that you loaded
+  #
+  # The best way to do this is as follows:
+  #   [People, Posts, ... etc ].reverse.each do |model|
+  #     model.destroy_all
+  #   end
+  # You should have an array of the models *in the same order* as in your load method. You should
+  # have ALL of the models in the database in this table to be safe.
+  def self.purge_seed
+  
+  end
+  
+  # Load up testing data for your test suite. Follows same pattern as load_seed
+  def self.load_data
+  
+  end
+  
+  # Purge the data that you loaded. Follows same pattern at purge_seed
+  def self.purge_data
+    self.purge_assets
+  end
+
+  private
+
+  # Here you can run file system calls to clean out any content directories you use.
+  # For example:
+  # FileUtils.rm_rf(File.join(RAILS_ROOT, 'content', RAILS_ENV))
+  def self.purge_assets
+  
   end
   
-end
+  ### Put your Seed loading methods here:
+  
+  
+  ### Put your data loading methods here:
+  
+  
+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

@@ -11,7 +11,7 @@ module StoryHelper
     end
 
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join(".")

data/story-helper.gemspec

@@ -1,22 +1,23 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
   s.name = %q{story-helper}
-  s.version = "0.1.0"
+  s.version = "0.2.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.date = %q{2009-01-30}
   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.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.textile", "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"]
   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.rubygems_version = %q{1.3.1}
   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"]
 
@@ -24,12 +25,12 @@ Gem::Specification.new do |s|
     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"])
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
     else
-      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.2"])
     end
   else
-    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.2"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jtrupiano-story-helper
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - John Trupiano
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-16 00:00:00 -07:00
+date: 2009-01-30 00:00:00 -08:00
 default_executable: storify
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 1.8.2
     version: 
 description: A set of helpers/features to aid in implementing the StoryHelper concept in rails apps
 email: 
@@ -31,23 +31,23 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README.textile
 - 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
+homepage: 
 post_install_message: 
 rdoc_options: 
 - --main