rdx 0.9.0.pre → 0.9.0.pre.1

data/lib/rdx/generator.rb

@@ -55,7 +55,7 @@ module RDX
 		
 		#
 		# Merges the given _argv_ and _files_ (along with #custom_options)
-		# into a ingle +Array+ of options.
+		# into a single +Array+ of options.
 		#
 		def merge_argv_and_files argv, files
 			custom_options + argv + ['--'] + files

data/lib/rdx/generator/rdoc.rb

@@ -4,7 +4,7 @@ require 'rdoc'
 #
 # :rdx: off
 # 
-# This patch handles specific issues and comunication of RDoc with RDX, allowing it to work properly.
+# This patch handles specific issues and communication of RDoc with RDX, allowing it to work properly.
 # There are a few important thing to notify.
 # 
 # == Private RDX sections
@@ -23,7 +23,7 @@ require 'rdoc'
 #   /*
 #    *  [...]
 #    *-- rdx
-#    *  It's clear from the examples that x and y are generical...
+#    *  It's clear from the examples that x and y are generics...
 #    *     x = (-1)**rand(2) * (1+rand(10)*1.5)
 #    *     y = (-1)**rand(2) * (1+rand(10)*1.5)
 #    *++
@@ -158,8 +158,7 @@ module RDoc # :nodoc: all
 		end
 		
 		def absolute_location
-			root = RDoc.current.options.root
-			File.expand_path(location.absolute_name,root.dirname)
+			File.expand_path location.relative_name, RDoc.current.options.root
 		end
 		
 		alias initialize_wo_rdx initialize
@@ -938,7 +937,7 @@ module RDoc # :nodoc: all
 		
 		alias parse_file_wo_rdx parse_file
 		private :parse_file_wo_rdx
-		# SIGNAL INSERTION: Signal RDX the succesful end of parsing a file.
+		# SIGNAL INSERTION: Signal RDX the successful end of parsing a file.
 		def parse_file rel_fname
 			return parse_file_wo_rdx(rel_fname) unless RDX.active?
 			abs_fname = File.expand_path(rel_fname,options.root)
@@ -989,7 +988,7 @@ module RDX
 			end
 			
 			def customize_template tmpl
-				# The \z exposed at the end of regexp ensure that optimizations will occurr.
+				# The \z exposed at the end of regexp ensure that optimizations will occur.
 				# This can be very important with big html files
 				tmpl.sub /<\/footer>\s*\z/, '<p>' + RDX::SIGNATURE + ".\n\\&"
 			end

data/lib/rdx/options.rb

@@ -237,12 +237,12 @@ module RDX
 		# * +docquiet+: nothing is produced by the documentation generator;
 		# * +rdxfocused+ (default): writes to <tt>$stderr</tt> the output of the generator tool;
 		# * +essential+: writes to <tt>$stderr</tt> even the RDX messages: only the report will be sent to <tt>$stdout</tt>;
-		# * +summary+: <tt>$stdout</tt> contains only the headers of the report without messages, one per line.
+		# * +summary+: <tt>$stdout</tt> contains only the headers of the report without messages, one per line (unix-style).
 		#
 		define_option :reporter do
 			@reporter = 'rdxfocused'
 			@parser.on '-R', '--reporter REPORTER', String,
-			"Use REPORTER as the reporter" do |reporter|
+			"Use REPORTER as the reporter (see RDX::Options#reporter)" do |reporter|
 				@reporter = reporter
 			end
 		end
@@ -350,7 +350,11 @@ module RDX
 		end
 		
 		def finalize_argv argv
-			@files.concat argv
+			if argv.empty? # For security...
+				@dry_run = true
+				warn "No file specified. Processing the current directory with dry_run mode on for security"
+			end
+			files.concat argv
 			argv.clear
 		end
 		

data/lib/rdx/reporter.rb

@@ -95,6 +95,9 @@ module RDX
 		def result_code
 			''
 		end
+		def type_of? arg
+			arg == :Detection
+		end
 	end
 	
 	class Warning < Reportable
@@ -414,6 +417,20 @@ module RDX
 			def reportable_content reportable
 				reportable.report_header[/.+/]
 			end
+			def self.split_report output
+				result = []
+				output.split("\n").each do |line|
+					md = line.match %r%^
+						(?> \s*\d+\)\s+ )
+						(?> (.*):(\d+):\s* )     # \1: filename   \2: lineno
+						(?> ([A-Z][a-z]*) \s* )  # \3: reportable
+						(?: \[ (\w+) \] )?       # \4: type
+					%x
+					raise "Invalid report line:\n#{line}" unless md
+					result << [md[1], md[2].to_i, md[3], md[4]]
+				end
+				return result
+			end
 		end
 		
 	end

data/lib/rdx/ruby_lex.rb

@@ -54,7 +54,7 @@ module RDX
 		private :new_rdoc_scanner
 		
 		# Through <tt>RDoc::RubyLex.tokenize</tt> tokenizes the _ruby_ string and
-		# retunrs an array of +RDoc::RubyToken+.
+		# returns an array of +RDoc::RubyToken+.
 		# These are processed with #adjust_tokens if _adjust_tokens_ is +true+ (default).
 		# May raise a +ParseError+ if the input is invalid enough.
 		def tokenize ruby, adjust_tokens=true
@@ -75,7 +75,7 @@ module RDX
 		private :tokenize
 		
 		# The comments also include the trailing newline and any comment on
-		# successives lines until a blank one.
+		# successive lines until a blank one.
 		def adjust_tokens orig_tokens
 			tokens = []
 			current_tkcomment = comment_on_current_line = nil
@@ -146,7 +146,7 @@ module RDX
 		# Extracts the comments in _ruby_ string and returns an
 		# array of arrays <tt>[ [comment,line_no],... ]</tt>.
 		# The comments also include the trailing newline and any comment
-		# on successives lines until a blank one.
+		# on successive lines until a blank one.
 		# 
 		#   RDX::RubyLex.extract_comments <<EOS
 		#   # This is Ruby!

data/lib/rdx/runner.rb

@@ -134,7 +134,7 @@ module RDX
 		public :run
 		
 		#
-		# === Singal and Hooks ===
+		# === Signal and Hooks ===
 		# 
 		# Must be called elsewhere -> public -> checks @status
 		#

data/lib/rdx/statement.rb

@@ -38,7 +38,7 @@ module RDX
 			self
 		end
 		
-		# The Expectation of this stetement (may be +nil+ if invalid).
+		# The Expectation of this statement (may be +nil+ if invalid).
 		attr_reader :expectation
 		
 		# Contains only the expectation.

data/lib/rdx/store.rb

@@ -2,7 +2,7 @@
 module RDX
 	
 	#
-	# Stores RDX data and handles acccess to it.
+	# Stores RDX data and handles access to it.
 	#
 	class Store
 		

data/lib/rdx/task.rb

@@ -46,7 +46,7 @@ module RDX
 		
 	# :startdoc:
 		
-		# Name of the taks.
+		# Name of the task.
 		attr_accessor :name
 		
 		# Description of the task.

data/lib/rdx/text.rb

@@ -466,7 +466,7 @@ module RDX
 		# *   a +Regexp+
 		# *   a +String+, which is interpreted literally
 		# *   a +Symbol+, which represent a REGEXP constant
-		#     (if begins with <tt>CAPTURE_</tt> the pattern is surrounded capturing parhentesis)
+		#     (if begins with <tt>CAPTURE_</tt> the pattern is surrounded capturing parenthesis)
 		# 
 		#   str = "=> Float::MIN"
 		#   re = RDX::Text.build_pattern '=>', :CLASS

data/lib/rdx/version.rb

@@ -5,7 +5,7 @@ module RDX
     MAJOR = 0
     MINOR = 9
     PATCH = 0
-    BUILD = 'pre'
+    BUILD = 'pre.1'
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.').freeze
   end

data/rakefile

@@ -1,14 +1,17 @@
 
 require 'rubygems'
-require 'rake'
 require 'rubygems/package_task'
-require 'rdoc/task'
+require 'rake'
 
 $LOAD_PATH.unshift File.expand_path('lib',File.dirname(__FILE__))
 # Use this version without considering installation
 require 'rdx'
 
+RUBY_EX_DIR = 'examples/ruby-2.0.0-p0'.freeze
+CORE   = 'core'.freeze
+STDLIB = 'stdlib'.freeze
 
+require 'rdoc/task' # after rdx!!
 rdoc_task = RDoc::Task.new do |task|
 	task.title = 'RDX'
 	task.rdoc_files.add "lib/**/*.rb"
@@ -18,6 +21,33 @@ rdoc_task = RDoc::Task.new do |task|
 	task.options << '--line-numbers' << '--tab-width=2'
 end
 
+RDX::Task.new do |task|
+	task.rdoc_task = rdoc_task
+	task.debug = true
+	task.reporter = 'docquiet'
+#	task.fast = true
+end
+
+task :rdx_example_core do
+	cd "#{RUBY_EX_DIR}/#{CORE}" do
+		sh 'rake rdx'
+	end
+end
+task :rdx_example_stdlib do
+	cd "#{RUBY_EX_DIR}/#{STDLIB}" do
+		sh 'rake rdx'
+	end
+end
+task :rdx_example => [ :rdx_example_core, :rdx_example_stdlib ]
+task :rdx_all => [ :rdx, :rdx_example ]
+
+task :mk_example_install do
+	cd RUBY_EX_DIR do
+		sh 'rake mk_install'
+	end
+end
+
+
 spec = Gem::Specification.new do |s|
 	s.name = 'rdx'
 	s.version = RDX::VERSION
@@ -33,18 +63,21 @@ By running those tests, RDX gives formalism to documentation examples, greatly i
 	s.email = 'maurizio.destefanis@hotmail.it'
 	
 	s.required_ruby_version = '>= 2.0'
+	
 	s.add_runtime_dependency 'minitest'
 	s.add_runtime_dependency 'rdoc', '= 4.0.0'
+	
+	s.add_development_dependency 'rake'
 
 	s.rdoc_options = rdoc_task.option_list
-	s.files = %w(README rakefile .rdx) +
-		Dir.glob("lib/**/*") +
+	s.files = %w(README TODO rakefile .rdx) +
+		Dir.glob("{lib}/**/*") +
 		Dir.glob("examples/minimal/{lib/*,.rdx,rakefile,README}") +
-		Dir.glob("examples/ruby-2.0.0-p0/install/**/*") + [
-		"examples/ruby-2.0.0-p0/install/core/.rdx",
-		"examples/ruby-2.0.0-p0/install/stdlib/.rdx"
+		Dir.glob("#{RUBY_EX_DIR}/install/**/*") + [
+		"#{RUBY_EX_DIR}/install/core/.rdx",
+		"#{RUBY_EX_DIR}/install/stdlib/.rdx"
 		] +
-		Dir.glob("examples/ruby-2.0.0-p0/{rakefile,README}")
+		Dir.glob("#{RUBY_EX_DIR}/{rakefile,README}")
 	s.extra_rdoc_files = %w[ README ]
 	s.require_path = 'lib'
 	s.bindir = 'bin'
@@ -56,9 +89,5 @@ Gem::PackageTask.new(spec) do |task|
 	task.need_zip = false
 end
 
-RDX::Task.new do |task|
-	task.rdoc_task = rdoc_task
-	task.debug = true
-	task.reporter = 'docquiet'
-#	task.fast = true
-end
+desc "Build the gem for the release"
+task :gem_release => [ :clobber_package, :rdx_all, :mk_example_install, :gem ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdx
 version: !ruby/object:Gem::Version
-  version: 0.9.0.pre
+  version: 0.9.0.pre.1
 platform: ruby
 authors:
 - Maurizio Destefanis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -38,6 +38,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   The aim of RDX is to join the worlds of documentation and testing, which overlap in examples.
   Tests are built from the sources according to conventions and directives (built-in or defined by the user).
@@ -50,6 +64,7 @@ extra_rdoc_files:
 - README
 files:
 - README
+- TODO
 - rakefile
 - .rdx
 - lib/rdx/assertions.rb
@@ -80,6 +95,7 @@ files:
 - examples/minimal/.rdx
 - examples/minimal/rakefile
 - examples/minimal/README
+- examples/ruby-2.0.0-p0/install/core/BUGS
 - examples/ruby-2.0.0-p0/install/core/diffs/array.c.diff
 - examples/ruby-2.0.0-p0/install/core/diffs/bignum.c.diff
 - examples/ruby-2.0.0-p0/install/core/diffs/class.c.diff
@@ -135,8 +151,10 @@ files:
 - examples/ruby-2.0.0-p0/install/core/diffs/vm_eval.c.diff
 - examples/ruby-2.0.0-p0/install/core/diffs/vm_method.c.diff
 - examples/ruby-2.0.0-p0/install/core/diffs/vm_trace.c.diff
+- examples/ruby-2.0.0-p0/install/core/HALL_OF_SHAME
 - examples/ruby-2.0.0-p0/install/core/Rakefile
 - examples/ruby-2.0.0-p0/install/core/README
+- examples/ruby-2.0.0-p0/install/core/TODO
 - examples/ruby-2.0.0-p0/install/stdlib/diffs/lib/abbrev.rb.diff
 - examples/ruby-2.0.0-p0/install/stdlib/diffs/lib/base64.rb.diff
 - examples/ruby-2.0.0-p0/install/stdlib/diffs/lib/benchmark.rb.diff
@@ -162,8 +180,10 @@ files:
 - examples/ruby-2.0.0-p0/install/stdlib/diffs/lib/uri.rb.diff
 - examples/ruby-2.0.0-p0/install/stdlib/diffs/lib/weakref.rb.diff
 - examples/ruby-2.0.0-p0/install/stdlib/diffs/lib/yaml/store.rb.diff
+- examples/ruby-2.0.0-p0/install/stdlib/DOCUMENTATION
 - examples/ruby-2.0.0-p0/install/stdlib/Rakefile
 - examples/ruby-2.0.0-p0/install/stdlib/README
+- examples/ruby-2.0.0-p0/install/stdlib/TODO
 - examples/ruby-2.0.0-p0/install/core/.rdx
 - examples/ruby-2.0.0-p0/install/stdlib/.rdx
 - examples/ruby-2.0.0-p0/rakefile
@@ -196,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Ruby Documentation example eXecutor