jsmestad-stale_fish 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

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,50 @@
+= 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.
+
+== How To
+
+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: 
+    yahoo: 
+      filepath: ./tmp/yahoo.html
+      source: http://www.yahoo.com
+      updated: 
+      frequency: 1.day
+    google: 
+      filepath: git_commit.json
+      source: http://api.github.com/post_commit/
+      updated: 
+      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:
+
+  describe UsersController do
+    before do
+      StaleFish.load_config = "#{RAILS_ROOT}/config/stale_fish.yml"
+      StaleFish.update_stale
+    end
+    ....
+  end
+
+For all tests:
+
+  Spec::Runner.configure do |config|
+    ...
+    before do
+      StaleFish.load_config = "#{RAILS_ROOT}/config/stale_fish.yml"
+      StaleFish.update_stale
+    end
+    ....
+  end
+
+== 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 "rio", ">= 0.4.2"
+    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.0.0

data/lib/stale_fish.rb

@@ -0,0 +1,95 @@
+require 'singleton'
+require 'ftools'
+require 'yaml'
+require 'rubygems'
+require 'activesupport' # only used for time helpers
+require 'rio'
+
+module StaleFish
+  # no one likes stale fish.
+
+  def self.config_path=(path)
+    @config_path = path
+  end
+
+  def self.config_path
+    @config_path
+  end
+
+  def self.valid_path?
+    return false if @config_path.nil?
+    File.exist?(@config_path)
+  end
+
+  def self.update_stale(*args)
+    # check each file for update
+    load_yaml unless @yaml
+    stale = flag_stale(args)
+    process(stale)
+    write_yaml
+    return stale.size
+  end
+
+  def self.load_yaml
+    if valid_path?
+      @yaml = YAML.load_file(@config_path)
+      check_syntax
+    else
+      raise Errno::ENOENT, 'invalid path, please set StaleFish.config_path than ensure StaleFish.valid_path? is true'
+    end
+  end
+
+protected
+
+  def self.check_syntax
+    raise YAML::Error, 'missing stale root element' unless @yaml['stale']
+    @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]
+      end
+    end
+  end
+
+  def self.flag_stale(args)
+    force = args.pop[:force] if args.last.is_a?(Hash)
+    stale, scope = {}, @yaml['stale']
+    scope.each do |key, value|
+      if args.empty?
+        if scope[key]['updated'].blank?
+          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
+        end
+      else
+        last_modified = scope[key]['updated']
+        update_on = DateTime.now + eval(scope[key]['frequency'])
+        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)
+        end
+      end
+    end
+    return stale
+  end
+
+  def self.process(fixtures)
+    fixtures.each do |key, value|
+      rio(fixtures[key]['source']) > rio(fixtures[key]['filepath'])
+      update_fixture(key)
+    end
+  end
+
+  def self.update_fixture(key)
+    @yaml['stale'][key]['updated'] = DateTime.now
+  end
+
+  def self.write_yaml
+    File.open(@config_path, "w+") do |f|
+      f.write(@yaml.to_yaml)
+    end
+  end
+
+end

data/spec/fixtures/malformed_stale_fish.yml

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

data/spec/fixtures/stale_fish.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/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,55 @@
+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.config_path = @valid_yaml
+    StaleFish.config_path.should == @valid_yaml
+    StaleFish.valid_path?.should == true
+  end
+
+  context "when loading the yaml file" do
+    it "should raise errors on malformed yaml" do
+      StaleFish.config_path = File.dirname(__FILE__) + "/fixtures/malformed_stale_fish.yml"
+      lambda { StaleFish.load_yaml }.should_not raise_error(Errno::ENOENT)
+      lambda { StaleFish.load_yaml }.should raise_error(YAML::Error)
+    end
+
+    it "should pass on valid yaml" do
+      StaleFish.config_path = @valid_yaml
+      lambda { StaleFish.load_yaml }.should_not raise_error(YAML::Error)
+    end
+  end
+
+  context "after loading the config" do
+    before(:each) 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      
+    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 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)      
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: jsmestad-stale_fish
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Justin Smestad
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-01 00:00:00 -07: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: rio
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.2
+    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: 
+- .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/yahoo.html
+- spec/spec_helper.rb
+- spec/stale_fish_spec.rb
+- tmp/.gitignore
+has_rdoc: false
+homepage: http://github.com/jsmestad/stale_fish
+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.2.0
+signing_key: 
+specification_version: 3
+summary: keeps fixtures synchronized with sources to prevent outdated fixtures going undetected.
+test_files: 
+- spec/spec_helper.rb
+- spec/stale_fish_spec.rb