stale_fish 1.2.3

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+tmp/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin Smestad
+
+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.rdoc

@@ -0,0 +1,85 @@
+= Stale Fish
+
+This gem provides a method for keeping your fixtures in sync with their sources. This will prevent the scenario where your build is broken in production, but CI has a green build to do outdated fixture data. StaleFish also allows for FakeWeb integration and URI management.
+
+== Features
+
+* Fixture update frequency uses the ActiveSupport relative time DSL
+* Versioned configuration file & fixtures means fixtures are only updated once per project.
+* Manage FakeWeb stubbed URI's through StaleFish
+* Automatic detection for Rails & Rack apps (default configuration locations)
+* Test Framework agnostic (tested with Test::Unit & RSpec)
+* Update all fixtures, specified fixtures, or forced update are all supported through the StaleFish.update_stale(*args) method
+* Fixtures are ONLY updated when a valid HTTP request is made, if server returns anything other than 200, an error is thrown failing the tests.
+
+== How To
+
+Simply drop in a YAML file in your application (default location: {test/spec}/stale_fish.yml; overwrite by setting StaleFish::Utility.config_path) and issue the following commands.
+
+A sample YAML file:
+
+  stale:
+    configuration:
+      use_fakeweb: true
+    yahoo: 
+      file_path: RAILS_ROOT + '/spec/fixtures/yahoo.html'
+      source_url: http://www.yahoo.com
+      last_updated_at: 
+      update_frequency: 1.day
+    google: 
+      file_path:  RAILS_ROOT + '/spec/fixtures/github_commit.json'
+      source_url: http://api.github.com/post_commit/
+      last_updated_at: 
+      update_frequency: 2.weeks
+
+Specify one block for every fixture you would like to update. The frequency field takes any relative date included in the ActiveSupport library.
+
+=== RSpec
+
+For a single test add it to a before block
+
+  describe UsersController do
+    before do
+      StaleFish.update_stale("facebook", "yahoo")
+    end
+    ....
+  end
+
+For all tests add the following to spec_helper.rb
+
+  require 'stale_fish'
+
+  Spec::Runner.configure do |config|
+    ...
+    config.before do
+      StaleFish.update_stale
+    end
+    ....
+  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.update_stale
+    end
+    ...
+  end
+
+== More Info
+
+View the wiki: http://wiki.github.com/jsmestad/stale_fish
+
+== Thanks
+
+Paul Sadauskas for his work on Resourceful (used by StaleFish to provide accurate http handling when updating fixtures)
+
+== Copyright
+
+Copyright (c) 2009 Justin Smestad. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stale_fish"
+    gem.summary = %Q{ keeps fixtures synchronized with sources to prevent outdated fixtures going undetected. }
+    gem.email = "justin.smestad@gmail.com"
+    gem.homepage = "http://github.com/jsmestad/stale_fish"
+    gem.authors = ["Justin Smestad"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+
+    gem.add_dependency "fakeweb", ">= 1.2.4"
+    gem.add_dependency "resourceful", "~> 0.6.1"
+    gem.add_dependency "activesupport", ">= 2.1.2"
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stale_popcorn #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.2.3

data/lib/stale_fish/fakeweb.rb

@@ -0,0 +1,26 @@
+module StaleFish
+
+  class << self
+    attr_accessor :use_fakeweb
+  end
+
+  self.use_fakeweb = true
+
+  class FixtureDefinition
+    alias_method :update_without_fakeweb, :update!
+
+    def update!
+      FakeWeb.allow_net_connect = true
+      update_without_fakeweb
+      FakeWeb.allow_net_connect = false
+    end
+
+    def register_uri
+      if StaleFish.use_fakeweb && !FakeWeb.registered_uri?(:any, source_url)
+        FakeWeb.register_uri(:any, source_url, :body => file_path)
+      end
+    end
+
+  end
+
+end

data/lib/stale_fish/fixture_definition.rb

@@ -0,0 +1,34 @@
+module StaleFish
+
+  class FixtureDefinition
+    attr_accessor :tag, :file_path, :source_url, :last_updated_at, :response
+    attr_accessor :update_frequency
+
+    def is_stale?
+      StaleFish.force_flag || last_updated_at.nil? || ((DateTime.now + eval(update_frequency)) < last_updated_at)
+    end
+
+    def update!
+      begin
+        self.response = StaleFish.http.resource(source_url).get
+        File.open(eval(file_path), 'w') { |file| file.write(response.body.to_s) }
+        self.last_updated_at = DateTime.now
+      rescue Resourceful::UnsuccessfulHttpRequestError
+        raise StaleFish::FixtureUpdateFailure, "#{key}'s source: #{value['source']} returned unsuccessfully."
+      rescue ArgumentError
+        raise StaleFish::MalformedSourceURL, "#{key}'s source: #{value['source']} is not a valid URL path. Most likely it's missing a trailing slash."
+      end
+    end
+
+    def output_hash
+<<-EOF
+  #{tag}:
+    file_path: #{file_path}
+    source_url: #{source_url}
+    update_frequency: #{update_frequency}
+    last_updated_at: #{last_updated_at}
+EOF
+    end
+  end
+
+end

data/lib/stale_fish/utility.rb

@@ -0,0 +1,67 @@
+require 'singleton'
+
+module StaleFish
+  module Utility
+    class << self
+      attr_accessor :config_path
+    end
+
+    def self.valid_path?
+      !config_path.nil? ? File.exist?(config_path) : false
+    end
+
+    def self.loader
+      raise Errno::ENOENT, 'invalid config path: #{Utility.config_path}; ensure StaleFish::Utility.valid_path? is true' unless Utility.valid_path?
+
+      data = YAML.load_file(config_path)
+
+      config = data['stale'].delete('configuration')
+      StaleFish.use_fakeweb = (config['use_fakeweb'] || false) unless config.nil?
+
+      raise YAML::Error, 'missing root element' unless data['stale']
+
+      # Reset these
+      StaleFish.fixtures = []
+      StaleFish.force_flag = false
+
+      deprecated_var_names = {
+        'file_path' => 'filepath',
+        'update_frequency' => 'frequency',
+        'source_url' => 'source',
+        'last_updated_at' => 'updated'
+      }
+
+      data['stale'].each do |key, value|
+        definition = FixtureDefinition.new
+        definition.tag = key
+        %w{ file_path update_frequency source_url }.each do |field|
+          if value[deprecated_var_names[field]]
+            $stderr.puts "Deprecation warning: #{field} has been replaced with #{deprecated_var_names[field]}. Please update #{Utility.config_path}."
+            definition.send((field + '=').to_sym, value[deprecated_var_names[field]])
+          else
+            raise YAML::Error, "missing #{field} node for #{key} in #{Utility.config_path}" unless value[field]
+            definition.send((field + '=').to_sym, value[field])
+          end
+        end
+
+        $stderr.puts "Deprecation warning: updated has been changed to last_updated_at; this change is automatic." if value.has_key?('updated')
+        definition.last_updated_at = value['last_updated_at'] || value[deprecated_var_names['last_updated_at']] || nil
+
+        StaleFish.fixtures << definition
+      end
+    end
+
+    def self.writer
+      string = <<-EOF
+stale:
+  configuration:
+    use_fakeweb: #{StaleFish.use_fakeweb}
+EOF
+      StaleFish.fixtures.each do |fix|
+        string << fix.output_hash
+      end
+
+      File.open(config_path, "w+") { |f| f.write(string) }
+    end
+  end
+end

data/lib/stale_fish.rb

@@ -0,0 +1,54 @@
+require 'singleton'
+require 'ftools'
+require 'yaml'
+require 'rubygems'
+require 'activesupport' # only used for time helpers
+require 'resourceful'
+
+require 'stale_fish/utility'
+require 'stale_fish/fixture_definition'
+
+begin
+  require 'fakeweb'
+  require 'stale_fish/fakeweb'
+rescue LoadError; end
+
+module StaleFish
+  # no one likes stale fish.
+
+  class FixtureUpdateFailure < StandardError; end
+  class MalformedSourceURL < StandardError;  end
+
+  class << self
+    attr_accessor :configuration
+    attr_accessor :http
+    attr_accessor :fixtures
+    attr_accessor :force_flag
+  end
+
+  self.fixtures = []
+  Utility.config_path = 'stale_fish.yml'
+  self.http = Resourceful::HttpAccessor.new
+
+  def self.update_stale(*args)
+    # TODO move this to its own spot
+    Utility.loader if self.fixtures.empty?
+    self.force_flag = args.pop[:force] if args.last.is_a?(Hash)
+
+    stale = if args.empty?
+              fixtures.select { |f| f.is_stale? }
+            else
+              fixtures.select { |f| f.is_stale? && args.include?(f.tag) }
+            end
+
+    stale.each do |fixture|
+      fixture.update!
+    end
+
+    fixtures.each { |fixture| fixture.register_uri if StaleFish.use_fakeweb }
+
+    Utility.writer
+    return stale.size
+  end
+
+end

data/spec/deprecation_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe StaleFish do
+
+  before do
+    @deprecated_yaml = File.dirname(__FILE__) + "/fixtures/deprecated_yaml.yml"
+  end
+
+  it "should assign the config file" do
+    StaleFish::Utility.config_path = @deprecated_yaml
+    StaleFish::Utility.config_path.should == @deprecated_yaml
+    StaleFish::Utility.valid_path?.should == true
+  end
+
+  it "should map to valid attributes" do
+    pending
+    StaleFish::Utility.loader
+  end
+
+end

data/spec/fixtures/deprecated_yaml.yml

@@ -0,0 +1,12 @@
+--- 
+stale: 
+  yahoo: 
+    filepath: ./tmp/yahoo.html
+    source: http://www.yahoo.com/
+    updated: 
+    frequency: 1.day
+  google: 
+    filepath: ./tmp/google.html
+    source: http://www.google.com/
+    updated: 
+    frequency: 2.weeks

data/spec/fixtures/malformed_stale_fish.yml

@@ -0,0 +1,5 @@
+stale:
+  google:
+    file_path: google.html
+  yahoo:
+    update_frequency: 2.weeks.ago

data/spec/fixtures/stale_fish.yml

@@ -0,0 +1,11 @@
+stale: 
+  yahoo: 
+    file_path: ./tmp/yahoo.html
+    source_url: http://www.yahoo.com/
+    last_updated_at: 
+    update_frequency: 1.day
+  google: 
+    file_path: ./tmp/google.html
+    source_url: http://www.google.com/
+    last_updated_at: 
+    update_frequency: 2.weeks

data/spec/fixtures/stale_fish_fakeweb.yml

@@ -0,0 +1,13 @@
+stale:
+  configuration:
+    use_fakeweb: true
+  yahoo:
+    file_path: ./tmp/yahoo.html
+    source_url: http://www.yahoo.com/
+    update_frequency: 1.day
+    last_updated_at: 2009-09-25T17:31:11-06:00
+  google:
+    file_path: ./tmp/google.html
+    source_url: http://www.google.com/
+    update_frequency: 2.weeks
+    last_updated_at: 2009-09-25T17:31:11-06:00

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'stale_fish'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/stale_fish_spec.rb

@@ -0,0 +1,104 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "StaleFish" do
+
+  before do
+    @valid_yaml = File.dirname(__FILE__) + "/fixtures/stale_fish.yml"
+  end
+
+  it "should assign the config file" do
+    StaleFish::Utility.config_path = @valid_yaml
+    StaleFish::Utility.config_path.should == @valid_yaml
+    StaleFish::Utility.valid_path?.should == true
+  end
+
+  context "when loading the yaml file" do
+
+    it "should raise errors on malformed yaml" do
+      StaleFish::Utility.config_path = File.dirname(__FILE__) + "/fixtures/malformed_stale_fish.yml"
+      lambda { StaleFish::Utility.loader }.should_not raise_error(Errno::ENOENT)
+      lambda { StaleFish::Utility.loader }.should raise_error(YAML::Error)
+    end
+
+    it "shouldn't fail on valid yaml" do
+      StaleFish::Utility.config_path = @valid_yaml
+      lambda { StaleFish::Utility.loader }.should_not raise_error(YAML::Error)
+    end
+
+    it "should establish the fixture definitions" do
+      StaleFish::Utility.config_path = @valid_yaml
+      lambda { StaleFish::Utility.loader }
+    end
+
+  end
+
+  context "after loading the config" do
+
+    before(:each) do
+      FileUtils.cp(@valid_yaml, File.dirname(__FILE__) + "/fixtures/stale_fish.orig.yml")
+      StaleFish::Utility.config_path = @valid_yaml
+      StaleFish::Utility.valid_path?.should == true
+      StaleFish::Utility.loader
+    end
+
+    it "should update all stale fixtures" do
+      StaleFish.update_stale.should == 2
+    end
+
+    it "should update only the passed fixtures, if stale" do
+      StaleFish.update_stale('google').should == 1
+    end
+
+    it "should update all passed fixtures, when passed the :force flag" do
+      StaleFish.update_stale('google').should == 1
+      StaleFish.update_stale('google', :force => true).should == 1
+    end
+
+    it "should not have any remaining fixtures to update" do
+      StaleFish.update_stale.should == 2
+      StaleFish.fixtures = []           # this will force a reload of the YAML file.
+      StaleFish.fixtures.should == []   # ensure it was reset
+      StaleFish::Utility.loader
+      StaleFish.update_stale.should == 0
+    end
+
+    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)
+      StaleFish.fixtures = []
+    end
+
+  end
+
+  context "with FakeWeb" do
+
+    before(:each) do
+      @fakeweb_yaml = File.dirname(__FILE__) + '/fixtures/stale_fish_fakeweb.yml'
+      StaleFish::Utility.config_path = @fakeweb_yaml
+      StaleFish::Utility.valid_path?.should == true
+      StaleFish::Utility.loader
+      StaleFish.use_fakeweb = true
+      StaleFish.use_fakeweb.should == true
+    end
+
+    it "should register any FakeWeb URI's" do
+      definition = StaleFish.fixtures.first
+      definition.register_uri
+      FakeWeb.registered_uri?(definition.source_url).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.fixtures = []
+    end
+
+  end
+
+end

data/stale_fish.gemspec

@@ -0,0 +1,69 @@
+# 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.2.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Smestad"]
+  s.date = %q{2009-10-03}
+  s.email = %q{justin.smestad@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/stale_fish.rb",
+     "lib/stale_fish/fakeweb.rb",
+     "lib/stale_fish/fixture_definition.rb",
+     "lib/stale_fish/utility.rb",
+     "spec/deprecation_spec.rb",
+     "spec/fixtures/deprecated_yaml.yml",
+     "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/deprecation_spec.rb",
+     "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<resourceful>, ["~> 0.6.1"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1.2"])
+    else
+      s.add_dependency(%q<fakeweb>, [">= 1.2.4"])
+      s.add_dependency(%q<resourceful>, ["~> 0.6.1"])
+      s.add_dependency(%q<activesupport>, [">= 2.1.2"])
+    end
+  else
+    s.add_dependency(%q<fakeweb>, [">= 1.2.4"])
+    s.add_dependency(%q<resourceful>, ["~> 0.6.1"])
+    s.add_dependency(%q<activesupport>, [">= 2.1.2"])
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: stale_fish
+version: !ruby/object:Gem::Version 
+  version: 1.2.3
+platform: ruby
+authors: 
+- Justin Smestad
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-03 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: resourceful
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+description: 
+email: justin.smestad@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/stale_fish.rb
+- lib/stale_fish/fakeweb.rb
+- lib/stale_fish/fixture_definition.rb
+- lib/stale_fish/utility.rb
+- spec/deprecation_spec.rb
+- spec/fixtures/deprecated_yaml.yml
+- 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: true
+homepage: http://github.com/jsmestad/stale_fish
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: keeps fixtures synchronized with sources to prevent outdated fixtures going undetected.
+test_files: 
+- spec/deprecation_spec.rb
+- spec/spec_helper.rb
+- spec/stale_fish_spec.rb