change_watcher 0.1.1

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Cadenas
+
+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,42 @@
+= change_watcher
+
+A gem to keep track of data changes
+
+  require "rubygems"
+  require "change_watcher"
+
+  change_watcher = ChangeWatcher.new do
+    data_to_watch do
+      #scrape some interesting data from the web (account balance, ranking of something, prices, etc.), from the filesystem, or get it from any other data source
+      BankAccount.new(username, password).balance
+    end
+
+    on_change do |old, new|
+      #notify yourself with an email, growl, etc. about the change, or do any other interesting stuff
+      require 'gmail_sender'
+
+      g = GmailSender.new("gmail_account_user_name", "gmail_account_password")
+      g.send("someone@domain.com", "More money yay!!", "It was $#{old} and now it is $#{new}!!!!!") if new > old
+      g.send("someone@domain.com", "Less money, ouch", "It was $#{old} but now it is $#{new} :(" if new < old
+    end
+
+    #this gets the path for the yml file where all the changes will be stored or some object implementing a store interface (e.g. a database)
+    store_changes_in "/Users/daniel/.foobar_changes.yml"
+  end
+
+  #loop or create a script to call from cron
+  change_watcher.check_for_change
+
+There's also an optional define_change method you can use if you consider that old != new does not cover the concept of change. See the tests for more details.
+
+== Installation
+
+  sudo gem install dcadenas-change_watcher
+
+== Collaborate
+
+http://github.com/dcadenas/change_watcher
+
+== Copyright
+
+Copyright (c) 2009 Daniel Cadenas. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "change_watcher"
+    gem.summary = %Q{TODO}
+    gem.email = "dcadenas@gmail.com"
+    gem.homepage = "http://github.com/dcadenas/change_watcher"
+    gem.authors = ["Daniel Cadenas"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+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 = "change_watcher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/change_watcher.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{change_watcher}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Cadenas"]
+  s.date = %q{2009-06-18}
+  s.email = %q{dcadenas@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "change_watcher.gemspec",
+     "lib/change_watcher.rb",
+     "lib/change_watcher/file_store.rb",
+     "test/change_watcher/file_store_test.rb",
+     "test/change_watcher_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dcadenas/change_watcher}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{A gem to keep track of data changes}
+  s.test_files = [
+    "test/change_watcher/file_store_test.rb",
+     "test/change_watcher_test.rb",
+     "test/test_helper.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
+    else
+    end
+  else
+  end
+end

data/lib/change_watcher/file_store.rb

@@ -0,0 +1,29 @@
+class ChangeWatcher
+  class FileStore
+    def initialize(path_to_yaml_file)
+      @path_to_yaml_file = path_to_yaml_file
+    end
+
+    def empty?(yaml_stream = get_yaml_stream)
+      yaml_stream.nil? || yaml_stream.documents.empty?
+    end
+
+    def latest_value
+      yaml_stream = get_yaml_stream
+      return nil if empty?(yaml_stream)
+      yaml_stream.documents.last.last
+    end
+
+    def save(value)
+      File.open( @path_to_yaml_file, 'a' ) do |out|
+        YAML.dump( [Time.now, value], out )
+      end
+    end
+
+  private
+    def get_yaml_stream
+      return nil unless File.exists?(@path_to_yaml_file)
+      YAML::load_stream(File.open(@path_to_yaml_file))
+    end
+  end
+end

data/lib/change_watcher.rb

@@ -0,0 +1,55 @@
+require 'change_watcher/file_store'
+
+class ChangeWatcher
+  def initialize(&construction_block_dsl)
+    construction_block_interpreter = ConstructionBlockInterpreter.new(&construction_block_dsl)
+
+    @data_to_watch_block = construction_block_interpreter.data_to_watch_block
+    @on_change_block = construction_block_interpreter.on_change_block
+    @store = construction_block_interpreter.store
+    @change_test_block = construction_block_interpreter.change_test_block || lambda{|old, new| old != new}
+  end
+
+  def check_for_change
+    current_value = @data_to_watch_block.call
+
+    if value_changed?(current_value)
+      @on_change_block.call(@store.latest_value, current_value) if @on_change_block
+      @store.save(current_value)
+    end
+  end
+
+private 
+  def value_changed?(current_value)
+    @store.empty? || @change_test_block.call(@store.latest_value, current_value)
+  end
+  
+  class ConstructionBlockInterpreter
+    attr_reader :data_to_watch_block, :on_change_block, :store, :change_test_block
+
+    def initialize(&construction_block_dsl)
+      instance_eval(&construction_block_dsl)
+      raise ArgumentError unless @data_to_watch_block && @store
+    end
+
+    def data_to_watch(&data_to_watch_block)
+      @data_to_watch_block = data_to_watch_block
+    end
+
+    def on_change(&on_change_block)
+      @on_change_block = on_change_block
+    end
+
+    def store_changes_in(store)
+      if store.respond_to?(:to_str)
+        @store = FileStore.new(store.to_str)
+      else
+        @store = store
+      end
+    end
+
+    def define_change(&change_test_block)
+      @change_test_block = change_test_block
+    end
+  end
+end

data/test/change_watcher/file_store_test.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + "/../test_helper"
+require 'file_test_helper'
+include FileTestHelper
+
+Expectations do
+  expect nil do
+    with_files do
+     ChangeWatcher::FileStore.new("store.yml").latest_value
+    end
+  end
+
+  expect true do
+    with_files do
+     ChangeWatcher::FileStore.new("store.yml").empty?
+    end
+  end
+
+  expect true do
+    with_files "store.yml" => "" do
+     ChangeWatcher::FileStore.new("store.yml").empty?
+    end
+  end
+
+  expect false do
+    with_files "store.yml" => [Time.now, 6969].to_yaml do
+     ChangeWatcher::FileStore.new("store.yml").empty?
+    end
+  end
+
+  expect 6969 do
+    with_files "store.yml" => [Time.now, 6969].to_yaml do
+     ChangeWatcher::FileStore.new("store.yml").latest_value
+    end
+  end
+
+  expect 6969 do
+    with_files do
+      file_store = ChangeWatcher::FileStore.new("store.yml")
+      file_store.save(6969)
+      file_store.latest_value
+    end
+  end
+
+  expect 2 do
+    with_files do
+      file_store = ChangeWatcher::FileStore.new("store.yml")
+      file_store.save(1)
+      file_store.save(2)
+      file_store.latest_value
+    end
+  end
+
+  expect true do
+    with_files do
+      file_store = ChangeWatcher::FileStore.new("store.yml")
+      file_store.save(12345678)
+      file_store.save(87654321)
+
+      file_content = File.read("store.yml")
+      !!(file_content =~ /12345678/ && file_content =~ /87654321/)
+    end
+  end
+end

data/test/change_watcher_test.rb

@@ -0,0 +1,203 @@
+require File.dirname(__FILE__) + "/test_helper"
+require 'file_test_helper'
+include FileTestHelper
+
+Expectations do
+  expect "Something changed" do
+    result = "Nothing changed"
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        0
+      end
+
+      on_change do
+        result = "Something changed"
+      end
+
+      store_changes_in TestStore.new
+    end
+    
+    change_watcher.check_for_change
+    result
+  end
+
+  expect "Nothing changed" do
+    result = "Nothing changed"
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        0
+      end
+
+      on_change do
+        result = "Something changed"
+      end
+
+      store_changes_in TestStore.new
+    end
+    
+    change_watcher.check_for_change
+    result = "Nothing changed"
+    change_watcher.check_for_change
+    result
+  end
+
+  expect "Nothing changed" do
+    result = "Nothing changed"
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        0
+      end
+
+      define_change do |old_value, new_value|
+        old_value != new_value
+      end
+
+      on_change do
+        result = "Something changed"
+      end
+
+      store_changes_in TestStore.new
+    end
+    
+    change_watcher.check_for_change
+    result = "Nothing changed"
+    change_watcher.check_for_change
+    result
+  end
+
+  expect "Something changed" do
+    result = "Nothing changed"
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        0
+      end
+
+      define_change do |old_value, new_value|
+        old_value == new_value
+      end
+
+      on_change do
+        result = "Something changed"
+      end
+
+      store_changes_in TestStore.new
+    end
+    
+    change_watcher.check_for_change
+    result = "Nothing changed"
+    change_watcher.check_for_change
+    result
+  end
+
+  expect "It was 0 but now it is 1" do
+    watched_value = 0
+    result = "Nothing changed"
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        watched_value
+      end
+
+      on_change do |old_value, new_value|
+        result = "It was #{old_value} but now it is #{new_value}"
+      end
+
+      store_changes_in TestStore.new
+    end
+
+    change_watcher.check_for_change
+    watched_value = 1
+    change_watcher.check_for_change
+    result
+  end
+
+  expect "It was 1 but now it is 2" do
+    watched_value = 0
+    result = "Nothing changed"
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        watched_value
+      end
+
+      on_change do |old_value, new_value|
+        result = "It was #{old_value} but now it is #{new_value}"
+      end
+
+      store_changes_in TestStore.new
+    end
+    
+    change_watcher.check_for_change
+    watched_value = 1
+    change_watcher.check_for_change
+    watched_value = 2
+    change_watcher.check_for_change
+    result
+  end
+
+  expect false do
+    store = TestStore.new
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        0
+      end
+
+      store_changes_in store
+    end
+
+    change_watcher.check_for_change
+    store.empty?
+  end
+
+  expect false do
+    store = TestStore.new
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        0
+      end
+
+      store_changes_in store
+    end
+
+    change_watcher.check_for_change
+    change_watcher.check_for_change
+    store.empty?
+  end
+
+  expect true do
+    i = 0
+    store = TestStore.new
+
+    change_watcher = ChangeWatcher.new do
+      data_to_watch do
+        i += 1
+      end
+
+      store_changes_in store
+    end
+
+    change_watcher.check_for_change
+    !store.empty?
+  end
+
+  expect true do
+    with_files do
+      change_watcher = ChangeWatcher.new do
+        data_to_watch do
+          12345678
+        end
+
+        store_changes_in "store.yml"
+      end
+
+      change_watcher.check_for_change
+      !!(File.read("store.yml") =~ /12345678/)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'expectations'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'change_watcher'
+
+class TestStore
+  def initialize
+    @array = []
+  end
+
+  def latest_value
+    @array.last
+  end
+
+  def empty?
+    @array.empty?
+  end
+
+  def save(value)
+    @array << value
+  end
+end
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: change_watcher
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Daniel Cadenas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-18 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dcadenas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- change_watcher.gemspec
+- lib/change_watcher.rb
+- lib/change_watcher/file_store.rb
+- test/change_watcher/file_store_test.rb
+- test/change_watcher_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/dcadenas/change_watcher
+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.3
+signing_key: 
+specification_version: 3
+summary: A gem to keep track of data changes
+test_files: 
+- test/change_watcher/file_store_test.rb
+- test/change_watcher_test.rb
+- test/test_helper.rb