jsmestad-stale_fish 1.0.0 → 1.1.0

data/README.rdoc

@@ -7,8 +7,10 @@ This gem provides a method for keeping your fixtures in sync with their sources.
 Simply drop in a YAML file in your application (for rails, RAILS_ROOT/config/stale_fish.yml is preferred) and issue the following commands.
 
 A sample YAML file:
-  --- 
-  stale: 
+
+  stale:
+    configuration:
+      use_fakeweb: true
     yahoo: 
       filepath: ./tmp/yahoo.html
       source: http://www.yahoo.com
@@ -24,17 +26,17 @@ Specify one block for every fixture you would like to update. The frequency fiel
 
 === RSpec
 
-For a single test:
+For a single test add it to a before block
 
   describe UsersController do
     before do
       StaleFish.load_config = "#{RAILS_ROOT}/config/stale_fish.yml"
-      StaleFish.update_stale
+      StaleFish.update_stale("facebook", "yahoo")
     end
     ....
   end
 
-For all tests:
+For all tests add the following to spec_helper.rb
 
   Spec::Runner.configure do |config|
     ...
@@ -45,6 +47,26 @@ For all tests:
     ....
   end
 
+=== Test::Unit
+
+For all tests add the following to test_helper.rb
+
+  class Test::Unit::TestCase
+    ...
+    self.use_transactional_fixtures = true
+    self.use_instantiated_fixtures  = false
+    ...
+    setup do
+      StaleFish.load_config = "#{RAILS_ROOT}/config/stale_fish.yml"
+      StaleFish.update_stale
+    end
+    ...
+  end
+
+== More Info
+
+View the wiki: http://wiki.github.com/jsmestad/stale_fish
+
 == Copyright
 
 Copyright (c) 2009 Justin Smestad. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/stale_fish.rb

@@ -4,9 +4,23 @@ require 'yaml'
 require 'rubygems'
 require 'activesupport' # only used for time helpers
 require 'rio'
+begin
+  require "fakeweb"
+rescue LoadError
+
+end
 
 module StaleFish
   # no one likes stale fish.
+  def self.use_fakeweb=(enabled)
+    @use_fakeweb = enabled
+  end
+
+  def self.use_fakeweb
+    @use_fakeweb
+  end
+
+  self.use_fakeweb = false
 
   def self.config_path=(path)
     @config_path = path
@@ -23,13 +37,27 @@ module StaleFish
 
   def self.update_stale(*args)
     # check each file for update
-    load_yaml unless @yaml
+    load_yaml if self.yaml.nil?
     stale = flag_stale(args)
     process(stale)
     write_yaml
     return stale.size
   end
 
+  def self.yaml=(data)
+    @yaml = data
+  end
+
+  def self.yaml
+    !@yaml.nil? ? @yaml['stale'] : @yaml
+  end
+
+  def self.register_uri(source_uri, response)
+    if self.use_fakeweb && !FakeWeb.registered_uri?(source_uri)
+      FakeWeb.register_uri(:any, source_uri, :body => response)
+    end
+  end
+
   def self.load_yaml
     if valid_path?
       @yaml = YAML.load_file(@config_path)
@@ -43,6 +71,12 @@ protected
 
   def self.check_syntax
     raise YAML::Error, 'missing stale root element' unless @yaml['stale']
+
+    # Grab Configuration from YAML
+    @configuration = @yaml['stale'].delete('configuration')
+    self.use_fakeweb = (@configuration['use_fakeweb'] || false) unless @configuration.nil?
+
+    # Process remaining nodes as items
     @yaml['stale'].each do |key, value|
       %w{ filepath frequency source }.each do |field|
         raise YAML::Error, "missing #{field} node for #{key}" unless @yaml['stale'][key][field]
@@ -52,15 +86,19 @@ protected
 
   def self.flag_stale(args)
     force = args.pop[:force] if args.last.is_a?(Hash)
-    stale, scope = {}, @yaml['stale']
+    stale, scope = {}, self.yaml
     scope.each do |key, value|
       if args.empty?
         if scope[key]['updated'].blank?
-          stale.merge!({key => scope[key]}) 
+          stale.merge!({key => scope[key]})
         else
           last_modified = scope[key]['updated']
           update_on = DateTime.now + eval(scope[key]['frequency'])
-          stale.merge!({key => scope[key]}) if last_modified > update_on
+          if last_modified > update_on
+            stale.merge!({key => scope[key]})
+          else
+            self.register_uri(scope[key]['source'], scope[key]['filepath'])
+          end
         end
       else
         last_modified = scope[key]['updated']
@@ -68,7 +106,11 @@ protected
         if force == true
           stale.merge!({key => scope[key]}) if args.include?(key)
         else
-          stale.merge!({key => scope[key]}) if args.include?(key) && (scope[key]['updated'].blank? || last_modified > update_on)
+          if args.include?(key) && (scope[key]['updated'].blank? || last_modified > update_on)
+            stale.merge!({key => scope[key]})
+          else
+            self.register_uri(scope[key]['source'], scope[key]['filepath'])
+          end
         end
       end
     end
@@ -76,10 +118,15 @@ protected
   end
 
   def self.process(fixtures)
+    FakeWeb.allow_net_connect = true if self.use_fakeweb
+
     fixtures.each do |key, value|
       rio(fixtures[key]['source']) > rio(fixtures[key]['filepath'])
+      self.register_uri(fixtures[key]['source'], fixtures[key]['filepath'])
       update_fixture(key)
     end
+
+    FakeWeb.allow_net_connect = false if self.use_fakeweb
   end
 
   def self.update_fixture(key)

data/spec/fixtures/stale_fish_fakeweb.yml

@@ -0,0 +1,12 @@
+--- 
+stale: 
+  yahoo: 
+    filepath: ./tmp/yahoo.html
+    frequency: 1.day
+    updated: 2009-09-14 00:47:54 -06:00
+    source: http://www.yahoo.com
+  google: 
+    filepath: ./tmp/google.html
+    frequency: 2.weeks
+    updated: 2009-09-14 00:47:54 -06:00
+    source: http://www.google.com

data/spec/stale_fish_spec.rb

@@ -22,6 +22,7 @@ describe "StaleFish" do
       StaleFish.config_path = @valid_yaml
       lambda { StaleFish.load_yaml }.should_not raise_error(YAML::Error)
     end
+
   end
 
   context "after loading the config" do
@@ -29,7 +30,7 @@ describe "StaleFish" do
       FileUtils.cp(@valid_yaml, File.dirname(__FILE__)+"/fixtures/stale_fish.orig.yml")
       StaleFish.config_path = @valid_yaml
       StaleFish.valid_path?.should == true
-      StaleFish.load_yaml      
+      StaleFish.load_yaml
     end
 
     it "should update all stale fixtures" do
@@ -45,11 +46,39 @@ describe "StaleFish" do
       StaleFish.update_stale('google', :force => true).should == 1
     end
 
-    #it "should notify user, and rollback, if source is no longer valid"
+    it "should notify user, and rollback, if source is no longer valid"
 
     after(:each) do
       FileUtils.mv(@valid_yaml, File.dirname(__FILE__)+"/../tmp/stale_fish.test.yml")
-      FileUtils.mv(File.dirname(__FILE__)+"/fixtures/stale_fish.orig.yml", @valid_yaml)      
+      FileUtils.mv(File.dirname(__FILE__)+"/fixtures/stale_fish.orig.yml", @valid_yaml)
+      StaleFish.yaml = nil
+    end
+  end
+
+  context "with FakeWeb" do
+    before(:each) do
+      @fakeweb_yaml = File.dirname(__FILE__) + '/fixtures/stale_fish_fakeweb.yml'
+      StaleFish.config_path = @fakeweb_yaml
+      StaleFish.valid_path?.should == true
+      StaleFish.load_yaml
+      StaleFish.use_fakeweb = true
+      StaleFish.use_fakeweb.should == true
+    end
+
+    it "should register any FakeWeb URI's" do
+      StaleFish.register_uri("http://www.google.com", "some shit")
+      FakeWeb.registered_uri?("http://www.google.com").should == true
+    end
+
+    it "should turn off FakeWeb.allow_net_connect to process stale fixtures" do
+      FakeWeb.allow_net_connect = false
+      lambda { StaleFish.update_stale(:force => true) }.should_not raise_error
+      lambda { StaleFish.update_stale(:force => true) }.should_not change { FakeWeb.allow_net_connect? }
+    end
+
+    after(:each) do
+      StaleFish.yaml = nil
     end
   end
+
 end

data/stale_fish.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stale_fish}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Smestad"]
+  s.date = %q{2009-09-14}
+  s.email = %q{justin.smestad@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/stale_fish.rb",
+     "spec/fixtures/google.html",
+     "spec/fixtures/malformed_stale_fish.yml",
+     "spec/fixtures/stale_fish.yml",
+     "spec/fixtures/stale_fish_fakeweb.yml",
+     "spec/fixtures/yahoo.html",
+     "spec/spec_helper.rb",
+     "spec/stale_fish_spec.rb",
+     "stale_fish.gemspec",
+     "tmp/.gitignore"
+  ]
+  s.homepage = %q{http://github.com/jsmestad/stale_fish}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{keeps fixtures synchronized with sources to prevent outdated fixtures going undetected.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/stale_fish_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fakeweb>, [">= 1.2.4"])
+      s.add_runtime_dependency(%q<rio>, [">= 0.4.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1.2"])
+    else
+      s.add_dependency(%q<fakeweb>, [">= 1.2.4"])
+      s.add_dependency(%q<rio>, [">= 0.4.2"])
+      s.add_dependency(%q<activesupport>, [">= 2.1.2"])
+    end
+  else
+    s.add_dependency(%q<fakeweb>, [">= 1.2.4"])
+    s.add_dependency(%q<rio>, [">= 0.4.2"])
+    s.add_dependency(%q<activesupport>, [">= 2.1.2"])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsmestad-stale_fish
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Justin Smestad
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-01 00:00:00 -07:00
+date: 2009-09-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,12 +62,15 @@ files:
 - spec/fixtures/google.html
 - spec/fixtures/malformed_stale_fish.yml
 - spec/fixtures/stale_fish.yml
+- spec/fixtures/stale_fish_fakeweb.yml
 - spec/fixtures/yahoo.html
 - spec/spec_helper.rb
 - spec/stale_fish_spec.rb
+- stale_fish.gemspec
 - tmp/.gitignore
 has_rdoc: false
 homepage: http://github.com/jsmestad/stale_fish
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -88,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: keeps fixtures synchronized with sources to prevent outdated fixtures going undetected.