kagemusha 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-08-15
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,54 @@
+
+Kagemusha is copyrighted free software by Yuya Kato
+<yuyakato at gmail dot com> You can redistribute it and/or modify it under
+either the terms of the GPL or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+     a) place your modifications in the Public Domain or otherwise make them
+     Freely Available, such as by posting said modifications to Usenet or an
+     equivalent medium, or by allowing the author to include your
+     modifications in the software.
+
+     b) use the modified software only within your corporation or
+        organization.
+
+     c) rename any non-standard executables so the names do not conflict with
+     standard executables, which must also be provided.
+
+     d) make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or executable
+   form, provided that you do at least ONE of the following:
+
+     a) distribute the executables and library files of the software,
+     together with instructions (in the manual page or equivalent) on where
+     to get the original distribution.
+
+     b) accompany the distribution with the machine-readable source of the
+     software.
+
+     c) give non-standard executables non-standard names, with
+        instructions on where to get the original software distribution.
+
+     d) make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under this terms.
+
+5. The scripts and library files supplied as input to or produced as 
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them, 
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+License.txt
+Manifest.txt
+README.ja.txt
+README.txt
+Rakefile
+examples/date.rb
+examples/datetime.rb
+examples/first.rb
+examples/rand.rb
+examples/time.rb
+lib/kagemusha.rb
+lib/kagemusha/core.rb
+lib/kagemusha/date.rb
+lib/kagemusha/datetime.rb
+lib/kagemusha/rand.rb
+lib/kagemusha/time.rb
+lib/kagemusha/version.rb
+scripts/txt2html
+setup.rb
+test/test_date.rb
+test/test_datetime.rb
+test/test_helper.rb
+test/test_kagemusha.rb
+test/test_rand.rb
+test/test_time.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.ja.txt

@@ -0,0 +1,59 @@
+
+影武者 - テスト用モック作成支援ライブラリ
+=========================================
+
+これって何?
+-----------
+
+  Rubyでテストコードを記述するための便利ライブラリです。
+  
+  例えば日付関係のテストを記述する際にはDate.todayなどの
+  挙動を上書きするなどの手法がありますが、このやり方ですと
+  無駄にグローバル領域を汚染してしまいます。
+  
+  ブロックで指定された範囲内のみに限定して基本的なクラスの
+  挙動を上書きするために、このライブラリを作りました。
+
+  例:
+    require "kagemusha"
+
+    musha = Kagemusha.new(Time)
+    musha.defs(:now) { self.local(2000, 1, 1) }
+    musha.def(:to_s) { self.strftime("%Y-%m-%d") } 
+
+    musha.swap {
+      p Time.now      #=> Sat Jan 01 00:00:00 +0900 2000
+      p Time.now.to_s #=> "2000-01-01"
+    }
+
+  なお、よく使うと思われるDate、Time、randなどに対するモックを
+  いくつか標準で用意されています。
+  
+  例:
+    require "kagemusha/date"
+
+    musha = Kagemusha::Date.at(2000, 1, 1)
+    musha.swap {
+      p Date.today.to_s #=> "2000-01-01"
+    }
+
+
+インストール
+------------
+
+  Gemでインストールしてください。
+
+    $ gem install kagemusha
+
+
+利用例
+------
+
+  exampleディレクトリを見てください。
+
+
+サポート
+--------
+
+  何かありましたら下記までお願いします。
+    加藤 勇也 (Yuya Kato) <yuyakato at gmail.com>

data/README.txt

@@ -0,0 +1,64 @@
+
+Kagemusha - a library of testing mock-objects
+=============================================
+
+Welcome to Kagemusha
+--------------------
+
+  Kagemusha is a library of helper functions
+  for testing Ruby scripts.  It helps you generating
+  scoped mock-objects which overrides behavior of
+  the class restricted in given blocks, without
+  tainting a global area.
+  
+  For example, if you override Date.today when you write
+  something about dates, then the code will taint global
+  areas to no purpose.
+
+  If you use Kagemusha, the test code will override
+  behavior of the class restricted in given block.
+
+  Example:
+    require "kagemusha"
+
+    musha = Kagemusha.new(Time)
+    musha.defs(:now) { self.local(2000, 1, 1) }
+    musha.def(:to_s) { self.strftime("%Y-%m-%d") } 
+
+    musha.swap {
+      p Time.now      #=> Sat Jan 01 00:00:00 +0900 2000
+      p Time.now.to_s #=> "2000-01-01"
+    }
+
+  Also, it has default useful mock-objects set Date, Time,
+  rand, and so on.
+
+  Example:
+    require "kagemusha/date"
+
+    musha = Kagemusha::Date.at(2000, 1, 1)
+    musha.swap {
+      p Date.today.to_s #=> "2000-01-01"
+    }
+
+
+Installation
+------------
+
+  The easiest way to get started with Kagemusha is to
+  install it via RubyGems. You can do this easily:
+
+    $ gem install kagemusha
+
+
+Examples
+--------
+
+  see example directory.
+
+
+Support
+--------
+
+  Feel free to mail me:
+    Yuya Kato <yuyakato at gmail.com>

data/Rakefile

@@ -0,0 +1,123 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'kagemusha', 'version')
+
+AUTHOR = "Yuya Kato"  # can also be an array of Authors
+EMAIL = "yuyakato at gmail.com"
+DESCRIPTION = "Kagemusha is a library of helper functions for testing Ruby scripts."
+GEM_NAME = "kagemusha" # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'kagemusha' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "kagemusha"
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Kagemusha::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'kagemusha documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+

data/examples/date.rb

@@ -0,0 +1,19 @@
+
+# $Id: date.rb 26 2007-08-15 14:22:25Z yuyakato $
+
+require "rubygems"
+require "kagemusha/date"
+
+musha = Kagemusha::Date.on(2007, 1, 1)
+
+p Date.today.strftime("%Y-%m-%d")
+
+puts "---"
+
+musha.swap {
+  p Date.today.strftime("%Y-%m-%d")
+}
+
+puts "---"
+
+p Date.today.strftime("%Y-%m-%d")

data/examples/datetime.rb

@@ -0,0 +1,22 @@
+
+# $Id: datetime.rb 26 2007-08-15 14:22:25Z yuyakato $
+
+require "rubygems"
+require "kagemusha/datetime"
+
+musha = Kagemusha::DateTime.at(1984, 5, 11, 5, 15, 30)
+
+p Date.today.strftime("%Y-%m-%d")
+p Time.now
+
+puts "---"
+
+musha.swap {
+  p Date.today.strftime("%Y-%m-%d")
+  p Time.now
+}
+
+puts "---"
+
+p Date.today.strftime("%Y-%m-%d")
+p Time.now

data/examples/first.rb

@@ -0,0 +1,24 @@
+
+# $Id: first.rb 25 2007-08-15 14:18:09Z yuyakato $
+
+require "rubygems"
+require "kagemusha"
+
+musha = Kagemusha.new(Time)
+musha.defs(:now) { self.local(1984, 5, 11) }
+musha.def(:+) { |other| other }
+
+p Time.now
+p Time.now + 60 * 60 * 24
+
+puts "---"
+
+musha.swap {
+  p Time.now
+  p Time.now + 60 * 60 * 24
+}
+
+puts "---"
+
+p Time.now
+p Time.now + 60 * 60 * 24

data/examples/rand.rb

@@ -0,0 +1,22 @@
+
+# $Id: rand.rb 26 2007-08-15 14:22:25Z yuyakato $
+
+require "rubygems"
+require "kagemusha/rand"
+
+musha = Kagemusha::Rand.always(1)
+
+p rand(5)
+p rand(5)
+
+puts "---"
+
+musha.swap {
+  p rand(5)
+  p rand(5)
+}
+
+puts "---"
+
+p rand(5)
+p rand(5)

data/examples/time.rb

@@ -0,0 +1,19 @@
+
+# $Id: time.rb 26 2007-08-15 14:22:25Z yuyakato $
+
+require "rubygems"
+require "kagemusha/time"
+
+musha = Kagemusha::Time.at(2007, 1, 1)
+
+p Time.now
+
+puts "---"
+
+musha.swap {
+  p Time.now
+}
+
+puts "---"
+
+p Time.now