pd 1.0.3 → 1.0.5

data/.gitignore

@@ -1,2 +1,3 @@
-*~
-/.yardoc
+/rfrom/
+/*.gem
+/Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem "awesome_print"
+
+group :development do
+  gem "rspec"
+end

data/README.md

@@ -1,47 +1,18 @@
-pd, a print helper method for debug to Kernel
+pd, some helper methods to help debuging
 ==========================================
 
-**Homepage**: [https://github.com/GutenYe/pd](https://github.com/GutenYe/pd) <br/>
-**Author**: 	Guten <br/>
-**License**: MIT License <br/>
-**Documentation**: [http://rubydoc.info/gems/pd/frames](http://rubydoc.info/gems/pd/frames) <br/>
-**Issue Tracker**: [https://github.com/GutenYe/pd/issues](https://github.com/GutenYe/pd/issues) <br/>
+| Homepage:      |  https://github.com/GutenYe/pd       |
+|----------------|------------------------------------------------------       |
+| Author:	       | Guten                                                 |
+| License:       | MIT-LICENSE                                                |
+| Documentation: | http://rubydoc.info/gems/pd/frames                |
+| Issue Tracker: | https://github.com/GutenYe/pd/issues |
 
 Overview
 --------
-sometimes, I need debug other people's code, and I'd like to use `pd`, so add this lib to environment variable `RUBYOPT="-r pd"` make this happen.
 
-pd(print debug), for debug only, like p, but use ", " between each argument as separator instead of "\n".
-
-* search 'pd' is much easier than 'p' in source file.
-* sometimes use pd is much convient than p
-
-For example:
-	
-	pd :Person, name, age
-	#=>
-	  Person: "Alice", 12
-
-	p name, age
-	#=>
-	  "Alice"
-	  12
-
-Usage
------
-
-	add RUBYOPT as Environment Variable
-	RUBYOPT="-r pd" # for ruby1.9 
-	RUBYOPT="-r/absolute/path/to/pd" # for ruby1.8
-	pd "a","b"
-
-Contributing
--------------
-
-* report bugs/featues to issue tracker.
-* fork it and pull a request.
-* improve documentation.
-* feel free to post any ideas. 
+1. add 'pd' method to Kernel, 'pd' is much easy to search than orignal 'p' method.
+2. include 'awesome_print' gem
 
 Install
 ----------
@@ -50,4 +21,13 @@ Install
 
 Copyright
 ---------
-Copyright &copy; 2011 by Guten. this library released under MIT-License, See {file:LICENSE} for futher details.
+
+(the MIT License)
+
+Copyright (c) 2011 Guten
+
+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/Rakefile

@@ -1,24 +1,43 @@
-desc "release to rubygems"
+sudo = Process.pid==0 ? "" : "sudo"
+
+desc "build a gem file"
 task :release do
-	sh "gem build pd.gemspec"
-	sh "gem push pd-*.gem"
-	sh "rm pd-*.gem"
+	run "gem build pd.gemspec"
+	run "gem push *.gem"
+  run "#{sudo} gem install *.gem"
+	run "rm *.gem"
 end
 
-desc "install to local"
+desc "install a gem file"
 task :install do
-	sh "gem build pd.gemspec"
-	sh "gem install pd-*.gem"
-	sh "rm pd-*.gem"
+	run "gem build pd.gemspec"
+	run "#{sudo} gem install *.gem"
+	run "rm *.gem"
 end
 
-
-desc "testing the library"
+desc "autotest with watchr"
 task :test do
-	sh "rspec --color spec"
+	run "watchr pd.watchr"
+end
+
+desc "testing the libraray"
+namespace :test do
+	task :all do
+		run "rspec spec"
+	end
+end
+
+desc "run yard server --reload"
+task :doc do
+	run "yard server --reload"
+end
+
+desc "clean up"
+task :clean do
+	run "rm *.gem"
 end
 
-def sh cmd
+def run cmd
 	puts cmd
 	system cmd
 end

data/lib/pd.rb

@@ -1,3 +1,5 @@
+autoload :Pd_VERSION, "pd/version"
+
 module Kernel
 	# print for debug
 	#
@@ -8,15 +10,18 @@ module Kernel
 	# @overload pd(title, obj, ...)
 	#   @param [Symbol] title if first arg is a Captial Symbol, use it as title
 	#   @return [nil]
-	def pd *args
-		puts args.map{|v|v.inspect}.join(", ")
+	def pd(*args)
+		puts args.map{|v|v.inspect}.join(" ")
 	end
 
-	# *for debug* print hr. puts '='*14 + " #{name}"
+	# print hr. puts '='*14 + " #{name}"
 	#
 	# sometime, we just need a horizonal line to separate message for debug.
 	# @param [String] name
-	def phr name=nil
-		puts '='*14 + " #{name}"
+	def phr(name=nil)
+		puts "="*14 + " #{name}"
 	end
 end
+
+require "ap"
+

data/lib/pd/version.rb

@@ -0,0 +1 @@
+Pd_VERSION = "1.0.5"

data/pd.gemspec

@@ -1,10 +1,9 @@
-$: << "."
-require "version"
+Kernel.load File.expand_path("../lib/pd/version.rb", __FILE__)
 
 Gem::Specification.new do |s|
 	s.name = "pd"
-	s.version = VERSION::IS
-	s.summary = "a print helper method for debug to Kernel"
+	s.version = Pd_VERSION
+	s.summary = "some helper methods to help debuging"
 	s.description = <<-EOF
 a print helper method for debug to Kernel
 	EOF
@@ -15,4 +14,6 @@ a print helper method for debug to Kernel
 	s.rubyforge_project = "xx"
 
 	s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "awesome_print"
 end

data/pd.watchr

@@ -14,8 +14,8 @@ Signal.trap('QUIT') do
 	test "spec"
 end
 
-def test path
-	cmd = "rspec --color #{path}"
+def test(path)
+	cmd = "rspec #{path}"
 	puts cmd
 	system cmd
 end

data/spec/pd_spec.rb

@@ -1,5 +1,4 @@
 require "spec_helper"
-require "pd"
 
 describe Kernel do
 	describe "#pd" do
@@ -7,7 +6,7 @@ describe Kernel do
 			message = capture :stdout do
 				pd "foo", "bar"
 			end
-			message.should =~ /"foo" "bar"/
+			message.should == %~"foo" "bar"\n~
 		end
 	end
 
@@ -19,5 +18,4 @@ describe Kernel do
 			message.should =~ /======.*foo/
 		end
 	end
-
 end

data/spec/spec_helper.rb

@@ -1,15 +1,13 @@
 require "stringio"
+require "pd"
 
-RSpec.configure do |config|
+$spec_dir = File.expand_path("..", __FILE__)
+$spec_data = File.expand_path("../data", __FILE__)
 
-  # a helper to capture stream
-  #
-  # @example
-  #   capture(:stdout){..}
-  # @param [Symbol] stream
-  # @return [String] print result in block
-  def capture stream
+RSpec.configure do |config|
+  def capture(stream)
     begin
+      stream = stream.to_s
       eval "$#{stream} = StringIO.new"
       yield
       result = eval("$#{stream}").string
@@ -19,4 +17,29 @@ RSpec.configure do |config|
 
     result
   end
+
+  alias :silence :capture
 end
+
+module Kernel 
+private
+
+  def xdescribe(*args, &blk)
+    describe *args do
+      pending "xxxxxxxxx"
+    end
+  end
+
+  def xcontext(*args, &blk)
+    context *args do
+      pending "xxxxxxxxx"
+    end
+  end
+
+  def xit(*args, &blk)
+    it *args do
+      pending "xxxxxxxx"
+    end
+  end
+end
+

metadata

@@ -1,66 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pd
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.5
   prerelease: 
-  version: 1.0.3
 platform: ruby
-authors: 
+authors:
 - Guten
 autorequire: 
 bindir: bin
 cert_chain: []
+date: 2012-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &11456500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11456500
+description: ! 'a print helper method for debug to Kernel
 
-date: 2011-07-05 00:00:00 Z
-dependencies: []
-
-description: |
-  a print helper method for debug to Kernel
-
+'
 email: ywzhaifei@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rspec
 - .yardopts
-- LICENSE
+- Gemfile
 - README.md
 - Rakefile
 - lib/pd.rb
+- lib/pd/version.rb
 - pd.gemspec
 - pd.watchr
 - spec/pd_spec.rb
 - spec/spec_helper.rb
-- version.rb
 homepage: http://github.com/GutenYe/pd
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: xx
-rubygems_version: 1.8.5
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: a print helper method for debug to Kernel
+summary: some helper methods to help debuging
 test_files: []
-
+has_rdoc: 

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2011 Guten
-
-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/version.rb

@@ -1,7 +0,0 @@
-module VERSION
-	MAJOR = 1
-	MINOR = 0
-	PATCH = 3
-
-	IS = [MAJOR, MINOR, PATCH].join(".") 
-end