zimbatm-monkeypatch 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,5 +1,7 @@
 = MonkeyPatch
 
+*WARNING: This is alpha code, the API is not stable yet.*
+
   <INSERT NICE INTRO HERE>
 
   Do you monkeys, patch ? If so, use this library, you won't regret it.
@@ -12,22 +14,30 @@
 
   </INSERT NICE INTRO HERE>
 
-== Usage
+Authors:: [ zimbatm <zimbatm@oree.ch> ]
+
+== Getting started
 
 Example usage:
 
   :include:example/patch_usage.rb
 
-== Related projects
+Look at the MonkeyPatch module to get an idea of the API.
+
+Once you have a patch object, look at the MonkeyPatch::Patch definition to know how to use it.
+
+----
+
+==== Related projects
 
 * http://github.com/coderrr/monkey_shield/ : provides sorts of namespaces to avoid patch collision
 
-== Ideas
+==== Ideas
 
 * method re-definition or module/class extension could be detected, especially when using Gems. The load-path is not the same between the original definition and the new-one.
 * load-path as namespace
 
-== TODO
+==== TODO
 
 * Add programmable patching conditions
 * Add reason string

data/example/patch_usage.rb

@@ -1,16 +1,16 @@
 require 'monkeypatch'
 
 # Define a new extension that adds the #to_blob method
-date_patch = MonkeyPatch.add_method(:to_blob) do
+blob_patch = MonkeyPatch.add_method(:to_blob) do
   def to_blob; "<blob>" end
 end
 
 x = "something"
-date_patch.patch_instance(x)
+blob_patch.patch_instance(x)
 x.to_blob #=> "<blob>"
 
 # Define a patch, that replaces the #to_date method
-each_patch = MonkeyPatch.replace_method(:to_s) do
+str_patch = MonkeyPatch.replace_method(:to_s) do
   def to_s; "..." end
 end
 
@@ -18,7 +18,8 @@ class ExampleClass
   def to_s; "hello" end
 end
 
-(date_patch & each_patch).patch_class(ExampleClass)
+(blob_patch & str_patch).patch_class(ExampleClass)
 
 ExampleClass.new.to_s #=> "..."
 ExampleClass.new.to_blob #=> "<blob>"
+

data/lib/monkeypatch.rb

@@ -7,7 +7,7 @@ Once you have a patch, look at Patch and it's children to see how to use it.
 =end
 module MonkeyPatch
   # MonkeyPatch's version as a string
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   # May be raised on check_conflicts
   class ConflictError < StandardError; end
   

data/task/gem.rake

@@ -15,22 +15,23 @@ spec = Gem::Specification.new do |s|
   s.test_files = FileList['test/test*.rb']
 end
 
-file "ruby-monkeypatch.gemspec" do |t|
-  File.open(t.name, 'w') do |f|
-    f.write(spec.to_ruby)
-  end
-end
-
 Rake::GemPackageTask.new(spec) do |pkg|
 #  pkg.need_zip = true
 #  pkg.need_tar = true
 end
+task :gem => "gem:spec"
 
 namespace :gem do
-  desc "Updates the ruby-monkeypatch.gemspec file"
+
+  spec_name = "ruby-monkeypatch.gemspec"
+  desc "Updates the #{spec_name} file if VERSION has changed"
   task :spec do
-    File.open("ruby-monkeypatch.gemspec", 'w') do |f|
-      f.write(spec.to_ruby)
+    if !File.exist?(spec_name) ||
+      eval(File.read(spec_name)).version.to_s != MonkeyPatch::VERSION
+      File.open(spec_name, 'w') do |f|
+        f.write(spec.to_ruby)
+      end
+      STDOUT.puts "*** Gem specification updated ***"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: zimbatm-monkeypatch
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - zimbatm