jsmestad-stale_fish 1.1.3 → 1.2.1

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.2.1

data/lib/stale_fish.rb

@@ -4,11 +4,14 @@ require 'yaml'
 require 'rubygems'
 require 'activesupport' # only used for time helpers
 require 'resourceful'
-begin
-  require "fakeweb"
-rescue LoadError
 
-end
+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.
@@ -17,114 +20,38 @@ module StaleFish
   class MalformedSourceURL < StandardError;  end
 
   class << self
-    attr_accessor :use_fakeweb
-    attr_accessor :config_path
-    attr_accessor :yaml
     attr_accessor :configuration
     attr_accessor :http
+    attr_accessor :fixtures
+    attr_accessor :force_flag
   end
 
-  self.use_fakeweb = false
-  self.config_path = 'stale_fish.yml'
+  self.fixtures = []
+  Utility.config_path = 'stale_fish.yml'
   self.http = Resourceful::HttpAccessor.new
 
-  def self.valid_path?
-    !config_path.nil? ? File.exist?(config_path) : false
-  end
-
   def self.update_stale(*args)
-    # check each file for update
-    load_yaml if self.yaml.nil?
-    stale = flag_stale(args)
-    process(stale)
-    write_yaml
-    return stale.size
-  end
-
-  def self.register_uri(source_uri, response)
-    FakeWeb.register_uri(:any, source_uri, :body => response) if use_fakeweb && !FakeWeb.registered_uri?(source_uri)
-  end
-
-  def self.load_yaml
-    raise Errno::ENOENT, 'invalid path, please set StaleFish.config_path than ensure StaleFish.valid_path? is true' unless valid_path?
-
-    self.yaml = YAML.load_file(config_path)
-    raise YAML::Error, 'missing stale root element' unless self.yaml['stale']
-
-    # Grab Configuration from YAML
-    self.configuration = self.yaml['stale'].delete('configuration')
-    use_fakeweb = (configuration['use_fakeweb'] || false) unless configuration.nil?
-
-    # Process remaining nodes as items
-    self.yaml['stale'].each do |key, value|
-      %w{ filepath frequency source }.each { |field| raise YAML::Error, "missing #{field} node for #{key}" unless value[field] }
-    end
-  end
-
-protected
-
-  def self.flag_stale(args)
-    force = args.pop[:force] if args.last.is_a?(Hash)
-    stale, scope = {}, self.yaml['stale']
-    scope.each do |key, value|
-      if args.empty?
-        if value['updated'].blank?
-          stale.merge!({key => value})
-        else
-          last_modified = value['updated']
-          update_on = DateTime.now + eval(value['frequency'])
-          if last_modified > update_on
-            stale.merge!({key => value})
-          else
-            register_uri(value['source'], value['filepath'])
-          end
-        end
-      else
-        last_modified = value['updated']
-        update_on = DateTime.now + eval(value['frequency'])
-        if force == true
-          stale.merge!({key => value}) if args.include?(key)
-        else
-          if args.include?(key) && (value['updated'].blank? || last_modified > update_on)
-            stale.merge!({key => value})
-          else
-            register_uri(value['source'], value['filepath'])
-          end
+    # 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)
+
+    if args.empty?
+      stale = fixtures.select { |f| f.is_stale? }
+      fixtures.each do |fixture|
+        fixture.update! if fixture.is_stale?
+        fixture.register_uri if StaleFish.use_fakeweb
+      end
+    else
+      stale = fixtures.select { |f| f.is_stale? && args.include?(f.tag) }
+      fixtures.each do |fixture|
+        if args.include?(fixture.tag)
+          fixture.update! if fixture.is_stale?
+          fixture.register_uri if StaleFish.use_fakeweb
         end
       end
     end
-    return stale
-  end
-
-  def self.process(fixtures)
-    FakeWeb.allow_net_connect = true if use_fakeweb
-
-    fixtures.each do |key, value|
-
-      begin
-        @response = http.resource(value['source']).get
-        File.open(value['filepath'], 'w') { |f| f.write @response.body.to_s }
-        update_fixture(key)
-      rescue Resourceful::UnsuccessfulHttpRequestError
-        raise FixtureUpdateFailure, "#{key}'s source: #{value['source']} returned unsuccessfully."
-      rescue ArgumentError
-        raise MalformedSourceURL, "#{key}'s source: #{value['source']} is not a valid URL path. Most likely it's missing a trailing slash."
-      end
-
-      register_uri(value['source'], value['filepath'])
-    end
-
-    FakeWeb.allow_net_connect = false if use_fakeweb
-  end
-
-  def self.update_fixture(key)
-    self.yaml['stale'][key]['updated'] = DateTime.now
-  end
-
-  def self.write_yaml
-    File.open(config_path, "w+") do |f|
-      f.write(self.yaml.to_yaml)
-    end
+    Utility.writer
+    return stale.size
   end
 
 end

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?(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(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/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

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

data/spec/fixtures/stale_fish.yml

@@ -1,12 +1,11 @@
---- 
 stale: 
   yahoo: 
-    filepath: ./tmp/yahoo.html
-    source: http://www.yahoo.com/
-    updated: 
-    frequency: 1.day
+    file_path: ./tmp/yahoo.html
+    source_url: http://www.yahoo.com/
+    last_updated_at: 
+    update_frequency: 1.day
   google: 
-    filepath: ./tmp/google.html
-    source: http://www.google.com/
-    updated: 
-    frequency: 2.weeks
+    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

@@ -1,12 +1,13 @@
---- 
-stale: 
-  yahoo: 
-    filepath: ./tmp/yahoo.html
-    frequency: 1.day
-    updated: 2009-09-15T11:58:51-06:00
-    source: http://www.yahoo.com/
-  google: 
-    filepath: ./tmp/google.html
-    frequency: 2.weeks
-    updated: 2009-09-15T11:58:51-06:00
-    source: http://www.google.com/
+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:17:20-06:00
+  google:
+    file_path: ./tmp/google.html
+    source_url: http://www.google.com/
+    update_frequency: 2.weeks
+    last_updated_at: 2009-09-25T17:17:20-06:00

data/spec/stale_fish_spec.rb

@@ -1,36 +1,44 @@
 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
+    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.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)
+      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 pass on valid yaml" do
-      StaleFish.config_path = @valid_yaml
-      lambda { StaleFish.load_yaml }.should_not raise_error(YAML::Error)
+    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.config_path = @valid_yaml
-      StaleFish.valid_path?.should == true
-      StaleFish.load_yaml
+      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
@@ -48,9 +56,9 @@ describe "StaleFish" do
 
     it "should not have any remaining fixtures to update" do
       StaleFish.update_stale.should == 2
-      StaleFish.yaml = nil           # this will force a reload of the YAML file.
-      StaleFish.yaml.should == nil   # ensure it was reset
-      StaleFish.load_yaml
+      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
 
@@ -59,23 +67,26 @@ describe "StaleFish" do
     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.yaml = nil
+      StaleFish.fixtures = []
     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::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
-      StaleFish.register_uri("http://www.google.com", "some shit")
-      FakeWeb.registered_uri?("http://www.google.com").should == true
+      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
@@ -85,8 +96,9 @@ describe "StaleFish" do
     end
 
     after(:each) do
-      StaleFish.yaml = nil
+      StaleFish.fixtures = []
     end
+
   end
 
 end

data/stale_fish.gemspec

@@ -5,24 +5,28 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stale_fish}
-  s.version = "1.1.3"
+  s.version = "1.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Smestad"]
-  s.date = %q{2009-09-18}
+  s.date = %q{2009-09-25}
   s.email = %q{justin.smestad@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
   ]
   s.files = [
-    ".document",
-     ".gitignore",
+    ".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",
@@ -39,7 +43,8 @@ Gem::Specification.new do |s|
   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/deprecation_spec.rb",
+     "spec/spec_helper.rb",
      "spec/stale_fish_spec.rb"
   ]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsmestad-stale_fish
 version: !ruby/object:Gem::Version 
-  version: 1.1.3
+  version: 1.2.1
 platform: ruby
 authors: 
 - Justin Smestad
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-18 00:00:00 -07:00
+date: 2009-09-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,13 +52,17 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .document
 - .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
@@ -96,5 +100,6 @@ 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

data/.document

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