chunker 0.1.53 → 1.0.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008, Mahlon E. Smith
+Copyright (c) 2008-2011, Mahlon E. Smith <mahlon@martini.nu>
 
 All rights reserved.
 

data/Rakefile

@@ -1,15 +1,14 @@
 #!/usr/bin/env rake
 #
-# Chunker Rakefile
-#
 
 require 'rubygems'
 require 'pathname'
 
 require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
-require 'spec/rake/spectask'
 require 'rubygems/installer'
 require 'rubygems/uninstaller'
 
@@ -23,10 +22,10 @@ BASEDIR = Pathname.new( __FILE__ ).expand_path.dirname.relative_path_from( Pathn
 TEXT_FILES = %w{ Rakefile README LICENSE }.collect {|f| BASEDIR + f }
 
 SPECDIR    = BASEDIR + 'spec'
-SPEC_FILES = Pathname.glob( SPECDIR + '**/*_spec.rb' ).reject {|f| f =~ /^\.svn/ }
+SPEC_FILES = Pathname.glob( SPECDIR + '**/*_spec.rb' )
 
 LIBDIR    = BASEDIR + 'lib'
-LIB_FILES = Pathname.glob( LIBDIR + '**/*.rb').reject {|i| i =~ /\.svn/ }
+LIB_FILES = Pathname.glob( LIBDIR + '**/*.rb')
 
 RELEASE_FILES = TEXT_FILES + LIB_FILES + SPEC_FILES
 
@@ -54,24 +53,33 @@ end
 ######################################################################
 
 PKG_NAME      = 'chunker'
-PKG_VERSION   = find_pattern( LIBDIR + 'chunker.rb', /VERSION = ['"](\d\.\d(?:\/\d)?)['"]/ )
-PKG_REVISION  = find_pattern( LIBDIR + 'chunker.rb', /SVNRev = .+Rev: (\d+)/ )
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}.#{PKG_REVISION}"
+PKG_VERSION   = find_pattern( LIBDIR + 'chunker.rb', /VERSION = ['"](.+)['"]/ )
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 
 ######################################################################
 ### T A S K S
 ######################################################################
 
-task :default => [ :test, :package ]
+task :test    => 'test:spec'
+task :default => :test
+# task :default => [ :test, :package ]
 
 
-### Task: run rspec tests
+### Tasks: testing via rspec
 ###
-desc "Run tests"
-Spec::Rake::SpecTask.new('test') do |task|
-	task.spec_files = SPEC_FILES
-	task.spec_opts  = %w{ -c -fs }
+namespace :test do
+	desc 'Generate verbose and pretty output'
+	RSpec::Core::RakeTask.new( :spec ) do |task|
+		task.pattern = SPEC_FILES
+		task.rspec_opts  = ['-b', '-fd', '-c']
+	end
+
+	desc 'Generate quiet non-colored plain-text output'
+	RSpec::Core::RakeTask.new( :quiet ) do |task|
+		task.pattern = SPEC_FILES
+		task.rspec_opts  = ['-f', 'p']
+	end
 end
 
 
@@ -87,46 +95,23 @@ end
 ### Task: Create gem from source
 ###
 gem = Gem::Specification.new do |gem|
-	pkg_build = PKG_REVISION || 0
-
 	gem.summary           = "A convenience library for parsing __END__ tokens consistently."
 	gem.name              = PKG_NAME
-	gem.version           = "%s.%s" % [ PKG_VERSION, pkg_build ]
+	gem.version           = PKG_VERSION
 	gem.author            = 'Mahlon E. Smith'
 	gem.email             = 'mahlon@martini.nu'
 	gem.homepage          = 'http://projects.martini.nu/ruby-modules/wiki/Chunker'
-	gem.rubyforge_project = 'mahlon'
 	gem.has_rdoc          = true
+	gem.extra_rdoc_files  = ['README']
+	gem.rdoc_options      << '--main' << 'README'
+
 
 	gem.files = RELEASE_FILES.
 		collect {|f| f.relative_path_from(BASEDIR).to_s }
 	gem.test_files	= SPEC_FILES.
 		collect {|f| f.relative_path_from(BASEDIR).to_s }
 
-	gem.description = <<-EOF
-	Ruby provides an automatic constant called DATA, which is an IO object
-	that references all text in the current file under an __END__ token.
-
-	I find it convenient to use the __END__ area to store all sorts of
-	stuff, rather than have to worry about distributing separate files.
-
-	The DATA constant is determined from whatever ruby believes $0 to be.
-	It doesn't work inside of other required libraries, so you'll see stuff
-	like this all the time:
-
-	END = File.open( __FILE__ ).read.split( /^__END__/, 2 ).last
-
-	It works, but it's more work than I want to do.
-
-	Chunker solves this by parsing __END__ tokens for you, and making it
-	available in the form of a 'DATA_END' constant.  It installs this
-	constant into the class that includes Chunker, so you can use it again
-	and again, assuming you use a different file for each class.
-
-	It also automatically parses out other things that look like tokens, so
-	you can easily have multiple, distinct documents all embedded into the
-	__END__ block.
-	EOF
+	gem.description = "Embed arbitrary data and multiple, distinct documents within ruby files."
 end
 
 Rake::GemPackageTask.new( gem ) do |pkg|

data/lib/chunker.rb

@@ -1,10 +1,14 @@
-#!/usr/bin/ruby
+# vim: set nosta noet ts=4 sw=4:
+
+require 'strscan'
+require 'stringio'
+
 #
 # Chunker: A convenience library for parsing __END__ tokens consistently.
 #
 # == Version
 #
-#	$Id: chunker.rb 53 2008-11-09 00:27:36Z mahlon $
+#	$Id: chunker.rb,v 01a3332bfe0a 2011/01/22 03:41:16 mahlon $
 #
 # == Author
 #
@@ -17,20 +21,14 @@
 ###
 module Chunker
 
-	require 'strscan'
-	require 'stringio'
-
-	# SVN Revision
-	#
-	SVNRev = %q$Rev: 53 $
+	# VCS Revision
+	VCSRev = %q$Rev: 01a3332bfe0a $
 
-	# SVN Id
-	#
-	SVNId = %q$Id: chunker.rb 53 2008-11-09 00:27:36Z mahlon $
+	# VCS Id
+	VCSId = %q$Id: chunker.rb,v 01a3332bfe0a 2011/01/22 03:41:16 mahlon $
 
 	# Package version
-	#
-	VERSION = '0.1'
+	VERSION = '1.0.0'
 
 
 	### Parser class for __END__ data blocks.
@@ -40,11 +38,9 @@ module Chunker
 	class DataParser
 
 		# The mark for a DATA block.
-		#
 		END_TOKEN = /^__END__\r?\n/
 
 		# The mark for a 'sub' block.
-		#
 		CHUNK_TOKEN = /^__([A-Z\_0-9]+)__\r?\n/
 
 
@@ -59,11 +55,14 @@ module Chunker
 			@scanner = StringScanner.new( end_string )
 			io.close
 
+			# put each chunk into its own constant
+			#
 			if @scanner.check_until( CHUNK_TOKEN )
-				# put each chunk into its own constant
 				self.extract_blocks
+
+			# no sub blocks, put the whole mess into DATA_END
+			#
 			else
-				# no sub blocks, put the whole mess into DATA_END
 				@klass.const_set( :DATA_END, StringIO.new( end_string ) )
 			end
 		end
@@ -93,20 +92,20 @@ module Chunker
 				else
 					label = @scanner[1]
 
+					# Pull the next token text out of the data, set up the next pass
+					#
 					if data = @scanner.scan_until( CHUNK_TOKEN )
-						# Pull the next token text out of the data, set up the next pass
-						#
-						data         = data[ 0, data.length - @scanner[0].length ]
+						data = data[ 0, data.length - @scanner[0].length ]
 						@scanner.pos = self.next_position
+
+					# No additional blocks
+					#
 					else
-						# No additional blocks
-						#
 						data = @scanner.rest
 					end
 				end
 
 				# Add the IO constant to the class that included me.
-				#
 				@klass.const_set( "DATA_#{label}".to_sym, StringIO.new( data ) )
 			end
 		end
@@ -126,7 +125,6 @@ module Chunker
     def self.included( klass )
 		# klass.instance_eval{ __FILE__ }   awww, nope.
 		# __FILE__ won't work here, so we find the filename via caller().
-		#
 		io = File.open( caller(1).last.sub(/:.*?$/, ''), 'r' )
 
 		DataParser.new( klass, io )

data/spec/chunker_spec.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# vim: set nosta noet ts=4 sw=4 ft=rspec:
 
 BEGIN {
 	require 'pathname'
@@ -8,9 +8,8 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
+require 'rspec'
 require 'chunker'
-require 'rubygems'
-require 'spec'
 
 ENDSTUFF = <<ENDSTUFF
 Stuff within the end block.
@@ -65,53 +64,55 @@ __HURGADURGA__
 EO_FILE_TEXT
 
 
-describe Chunker::DataParser do
+describe Chunker do
 
-	it "doesn't include content above the __END__ token" do
-		klass = Class.new
-		dp = Chunker::DataParser.new( klass, StringIO.new( FILE_TEXT_MULTIPLE ))
-		dp.instance_variable_get( :@scanner ).string.
-			should_not =~ /This is stuff we shouldn't see/
-	end
+	describe Chunker::DataParser do
+
+		it "doesn't include content above the __END__ token" do
+			klass = Class.new
+			dp = Chunker::DataParser.new( klass, StringIO.new( FILE_TEXT_MULTIPLE ))
+			dp.instance_variable_get( :@scanner ).string.
+				should_not =~ /This is stuff we shouldn't see/
+		end
 
-	it "doesn't contain the __END__ token itself" do
-		klass = Class.new
-		dp = Chunker::DataParser.new( klass, StringIO.new( FILE_TEXT ))
-		dp.instance_variable_get( :@scanner ).string.should_not =~ /^__END__/
+		it "doesn't contain the __END__ token itself" do
+			klass = Class.new
+			dp = Chunker::DataParser.new( klass, StringIO.new( FILE_TEXT ))
+			dp.instance_variable_get( :@scanner ).string.should_not =~ /^__END__/
+		end
 	end
-end
 
 
-describe 'A class that includes Chunker' do
+	context 'when included from another class' do
 
-	it "has all content in DATA_END if there are no sub blocks" do
-		File.stub!( :open ).and_return( StringIO.new( FILE_TEXT ))
-		klass = Class.new { include Chunker }
+		it "has all content in DATA_END if there are no sub blocks" do
+			File.stub!( :open ).and_return( StringIO.new( FILE_TEXT ))
+			klass = Class.new { include Chunker }
 
-		klass.constants.should_not include( 'DATA_POOP' )
-		klass.constants.should_not include( 'DATA_HURRRRG' )
-		klass.constants.should_not include( 'DATA_HURGADURGA' )
-		klass.constants.should include( 'DATA_END' )
-	end
+			klass.constants.should_not include( 'DATA_POOP' )
+			klass.constants.should_not include( 'DATA_HURRRRG' )
+			klass.constants.should_not include( 'DATA_HURGADURGA' )
+			klass.constants.should include( 'DATA_END' )
+		end
 
-	it "separates data sub blocks into individual constants" do
-		File.stub!( :open ).and_return( StringIO.new( FILE_TEXT_MULTIPLE ))
-		klass = Class.new { include Chunker }
+		it "separates data sub blocks into individual constants" do
+			File.stub!( :open ).and_return( StringIO.new( FILE_TEXT_MULTIPLE ))
+			klass = Class.new { include Chunker }
 
-		klass.constants.should include( 'DATA_END' )
-		klass.constants.should include( 'DATA_POOP' )
-		klass.constants.should include( 'DATA_HURRRRG' )
-		klass.constants.should include( 'DATA_HURGADURGA' )
-	end
+			klass.constants.should include( 'DATA_END' )
+			klass.constants.should include( 'DATA_POOP' )
+			klass.constants.should include( 'DATA_HURRRRG' )
+			klass.constants.should include( 'DATA_HURGADURGA' )
+		end
 
-	it "has IO constants that contain the data block contents" do
-		File.stub!( :open ).and_return( StringIO.new( FILE_TEXT_MULTIPLE ))
-		klass = Class.new { include Chunker }
+		it "has IO constants that contain the data block contents" do
+			File.stub!( :open ).and_return( StringIO.new( FILE_TEXT_MULTIPLE ))
+			klass = Class.new { include Chunker }
 
-		klass.const_get( :DATA_END ).read.chomp.should        == ENDSTUFF
-		klass.const_get( :DATA_POOP ).read.chomp.should       == POOP
-		klass.const_get( :DATA_HURRRRG ).read.chomp.should    == HURRRRG
-		klass.const_get( :DATA_HURGADURGA ).read.chomp.should == HURGADURGA
+			klass.const_get( :DATA_END ).read.chomp.should        == ENDSTUFF
+			klass.const_get( :DATA_POOP ).read.chomp.should       == POOP
+			klass.const_get( :DATA_HURRRRG ).read.chomp.should    == HURRRRG
+			klass.const_get( :DATA_HURGADURGA ).read.chomp.should == HURGADURGA
+		end
 	end
 end
-

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chunker
 version: !ruby/object:Gem::Version 
-  version: 0.1.53
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Mahlon E. Smith
@@ -9,18 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-10 00:00:00 -08:00
+date: 2011-01-22 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: "Ruby provides an automatic constant called DATA, which is an IO object that references all text in the current file under an __END__ token.  I find it convenient to use the __END__ area to store all sorts of stuff, rather than have to worry about distributing separate files.  The DATA constant is determined from whatever ruby believes $0 to be. It doesn't work inside of other required libraries, so you'll see stuff like this all the time:  END = File.open( __FILE__ ).read.split( /^__END__/, 2 ).last  It works, but it's more work than I want to do.  Chunker solves this by parsing __END__ tokens for you, and making it available in the form of a 'DATA_END' constant.  It installs this constant into the class that includes Chunker, so you can use it again and again, assuming you use a different file for each class.  It also automatically parses out other things that look like tokens, so you can easily have multiple, distinct documents all embedded into the __END__ block."
+description: Embed arbitrary data and multiple, distinct documents within ruby files.
 email: mahlon@martini.nu
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - Rakefile
 - README
@@ -29,29 +35,38 @@ files:
 - spec/chunker_spec.rb
 has_rdoc: true
 homepage: http://projects.martini.nu/ruby-modules/wiki/Chunker
-post_install_message: 
-rdoc_options: []
+licenses: []
 
+post_install_message: 
+rdoc_options: 
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: mahlon
-rubygems_version: 1.3.1
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A convenience library for parsing __END__ tokens consistently.
 test_files: 
 - spec/chunker_spec.rb