text-data-tools 1.0.6 → 1.1.0

data/README.rdoc

@@ -1,6 +1,19 @@
 = text-data-tools
 
-Description goes here.
+This is a set of tools for extracting data from simple text files, where the data appears in regular formats, for example columns.
+
+== Examples
+
+These are taken from the test suite.
+
+Named variables:
+		file = TextDataTools::Named::DataFile.new('test/test_dat_2.dat', ':')
+		alpha_power = file.get_variable_value('Alpha power').to_f
+
+Columnar Data:
+		file = TextDataTools::Column::DataFile.new('test/test_dat.dat', true, /\S+/,  /(?:\#\s+)?\d:.*?(?=\d:)/)
+		array = file.get_2d_array(/i\+ temp/, /1.*time/)
+
 
 == Contributing to text-data-tools
  

data/README.rdoc.orig

@@ -0,0 +1,19 @@
+= text-data-tools
+
+Description goes here.
+
+== Contributing to text-data-tools
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Edmund Highcock. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -11,6 +11,7 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
+
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
@@ -51,3 +52,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+Rake.application.options.trace = false

data/VERSION

@@ -1 +1 @@
-1.0.6
+1.1.0

data/lib/text-data-tools.rb

@@ -1,6 +1,20 @@
 require 'fileutils'
 
+# This is a set of tools for extracting data from simple text files, where the data appears in regular formats, for example columns.
+# For more information see the individual submodules.
 module TextDataTools
+
+class DataFileBase
+
+		def exists?
+			FileTest.exists?(@filename)
+		end
+
+end
+
+# Tools for extracting data from text files where the data appears in columns
+# with or without headers for each column.
+module Column
 	#  Return a one-dimensional array containing data from the file filename,
 	#  which may or may not have a line of column headers,
 	#  in the column column_header, where column_header maybe either a string
@@ -127,23 +141,6 @@ module TextDataTools
 	class NotFoundError < StandardError
 	end
 
-	# Extract a variable value from the given file where the variable is defined
-	# in this form:
-	#   name sep value
-	# E.g.
-	# 	heat = 4.0
-	def self.get_variable_value(filename, name, sep='=')
-		value = nil
-		File.open(filename) do |file|
-			while line= file.gets
-				next unless line =~ Regexp.new("#{Regexp.escape(name)}\\s*#{Regexp.escape(sep)}\\s*(?<value>.*)")
-				value = $~[:value]
-					
-			end
-		end
-		raise NotFoundError.new("Can't find #{name} in #{filename}") unless value
-		value
-	end
 	def self.column_index_from_headers(line, column_header, header_match)
 		headers = line.scan(header_match)
 		#p headers
@@ -154,13 +151,13 @@ module TextDataTools
 		column_header = index_array.index(index_array.compact[0])
 	end
 
-	# This is a simple class which can interface with the methods of TextDataTools
+	# This is a simple class which can interface with the methods of TextDataTools::Column
 	# to prevent the user having to specify the file name and other properties of the 
 	# data file for every call. In a
 	# nutshell, create a new instance of this class giving it the filename, and any
 	# appropriate options,
 	# then call methods from TextDataTools omitting the appropriate arguments.
-	class TextDataFile
+	class DataFile < DataFileBase
 		def initialize(filename, has_header_line = false, match = /\S+/, header_match = /\S+/)
 			@filename = filename
 			@match = match
@@ -169,25 +166,22 @@ module TextDataTools
 			self
 		end
 		def get_1d_array(column_header)
-			TextDataTools.get_1d_array(@filename, @has_header_line, column_header, @match, @header_match)
+			TextDataTools::Column.get_1d_array(@filename, @has_header_line, column_header, @match, @header_match)
 		end
 		def get_1d_array_float(column_header)
-			TextDataTools.get_1d_array_float(@filename, @has_header_line, column_header, @match, @header_match)
+			TextDataTools::Column.get_1d_array_float(@filename, @has_header_line, column_header, @match, @header_match)
 		end
 		def get_1d_array_integer(column_header)
-			TextDataTools.get_1d_array_integer(@filename, @has_header_line, column_header, @match, @header_match)
+			TextDataTools::Column.get_1d_array_integer(@filename, @has_header_line, column_header, @match, @header_match)
 		end
 		def get_2d_array(column_header, index_header)
-			TextDataTools.get_2d_array(@filename, @has_header_line, column_header, index_header, @match, @header_match)
+			TextDataTools::Column.get_2d_array(@filename, @has_header_line, column_header, index_header, @match, @header_match)
 		end
 		def get_2d_array_float(column_header, index_header)
-			TextDataTools.get_2d_array(@filename, @has_header_line, column_header, index_header, @match, @header_match)
+			TextDataTools::Column.get_2d_array(@filename, @has_header_line, column_header, index_header, @match, @header_match)
 		end
 		def get_2d_array_integer(column_header, index_header)
-			TextDataTools.get_2d_array(@filename, @has_header_line, column_header, index_header, @match, @header_match)
-		end
-		def get_variable_value(name, sep)
-			TextDataTools.get_variable_value(@filename, name, sep)
+			TextDataTools::Column.get_2d_array(@filename, @has_header_line, column_header, index_header, @match, @header_match)
 		end
 		def exists?
 			FileTest.exists?(@filename)
@@ -200,4 +194,45 @@ module TextDataTools
 			#end
 		#end
 	end
+end
+
+#  Tools for dealing with files where named variables are assigned in the form
+#    name sep base
+#  E.g.
+#    height = 4.0
+module Named
+	# Extract a variable value from the given file where the variable is defined
+	# in this form:
+	#   name sep value
+	# E.g.
+	# 	heat = 4.0
+	def self.get_variable_value(filename, name, sep='=')
+		value = nil
+		File.open(filename) do |file|
+			while line= file.gets
+				next unless line =~ Regexp.new("#{Regexp.escape(name)}\\s*#{Regexp.escape(sep)}\\s*(?<value>.*)")
+				value = $~[:value]
+					
+			end
+		end
+		raise NotFoundError.new("Can't find #{name} in #{filename}") unless value
+		value
+	end
+	# This is a simple class which can interface with the methods of TextDataTools::Named
+	# to prevent the user having to specify the file name and other properties of the 
+	# data file for every call. In a
+	# nutshell, create a new instance of this class giving it the filename, and any
+	# appropriate options,
+	# then call methods from TextDataTools omitting the appropriate arguments.
+	class DataFile < DataFileBase
+		def initialize(filename, sep = ':')
+			@filename = filename
+			@sep = sep
+			self
+		end
+		def get_variable_value(name)
+			TextDataTools::Named.get_variable_value(@filename, name, @sep)
+		end
+	end
+end
 end # module TextDataTools

data/test/test_text-data-tools.rb

@@ -2,21 +2,21 @@ require 'helper'
 
 class TestTextDataTools < Test::Unit::TestCase
 	def test_1d
-		assert_raise(ArgumentError){TextDataTools.get_1d_array('test/test_dat.dat', true, 2.2)} 
-		assert_raise(ArgumentError){TextDataTools.get_1d_array('test/test_dat.dat',true, /ii\+ temp/, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)} 
-		array = TextDataTools.get_1d_array('test/test_dat.dat', true, /i\+ temp/, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
+		assert_raise(ArgumentError){TextDataTools::Column.get_1d_array('test/test_dat.dat', true, 2.2)} 
+		assert_raise(ArgumentError){TextDataTools::Column.get_1d_array('test/test_dat.dat',true, /ii\+ temp/, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)} 
+		array = TextDataTools::Column.get_1d_array('test/test_dat.dat', true, /i\+ temp/, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
 		#puts array
 		assert_equal(array.size, 18)
 		assert_equal(array[9].to_f, 0.9753E+09)
-		array = TextDataTools.get_1d_array_float('test/test_dat.dat', true, /i\+ temp/, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
+		array = TextDataTools::Column.get_1d_array_float('test/test_dat.dat', true, /i\+ temp/, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
 		assert_equal(array[9], 0.9753E+09)
 	end
 	def test_2d
-		array = TextDataTools.get_2d_array('test/test_dat.dat', true, /i\+ temp/, 0, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
+		array = TextDataTools::Column.get_2d_array('test/test_dat.dat', true, /i\+ temp/, 0, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
 		assert_equal(array.size, 2)
-		array = TextDataTools.get_2d_array('test/test_dat.dat', true, /i\+ temp/, 1, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
+		array = TextDataTools::Column.get_2d_array('test/test_dat.dat', true, /i\+ temp/, 1, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
 		assert_equal(array.size, 18)
-		array = TextDataTools.get_2d_array_float('test/test_dat.dat', true, /i\+ temp/, 0, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
+		array = TextDataTools::Column.get_2d_array_float('test/test_dat.dat', true, /i\+ temp/, 0, /\S+/, /(?:\#\s+)?\d:.*?(?=\d:)/)
 		assert_equal(array[0].size, 9)
 		assert_equal(array[1][0], 0.9753E+09)
 
@@ -24,15 +24,15 @@ class TestTextDataTools < Test::Unit::TestCase
 
 	end
 	def test_get_variable
-		variable = TextDataTools.get_variable_value('test/test_dat_2.dat', 'Q', ':')
+		variable = TextDataTools::Named.get_variable_value('test/test_dat_2.dat', 'Q', ':')
 		assert_equal(variable.to_f, 11.989644168449118)
-		variable = TextDataTools.get_variable_value('test/test_dat_2.dat', 'Fusion power', ':')
+		variable = TextDataTools::Named.get_variable_value('test/test_dat_2.dat', 'Fusion power', ':')
 		assert_equal(variable.to_f, 484.34196189744871)
 	end
 	def test_texdatafile_class
-		file = TextDataTools::TextDataFile.new('test/test_dat_2.dat')
-		assert_equal(file.get_variable_value('Alpha power', ':').to_f, 116.90499891894469 )
-		file = TextDataTools::TextDataFile.new('test/test_dat.dat', true, /\S+/,  /(?:\#\s+)?\d:.*?(?=\d:)/)
+		file = TextDataTools::Named::DataFile.new('test/test_dat_2.dat', ':')
+		assert_equal(file.get_variable_value('Alpha power').to_f, 116.90499891894469 )
+		file = TextDataTools::Column::DataFile.new('test/test_dat.dat', true, /\S+/,  /(?:\#\s+)?\d:.*?(?=\d:)/)
 		array = file.get_2d_array(/i\+ temp/, /1.*time/)
 		assert_equal(array.size, 2)
 		assert(file.exists?)

data/text-data-tools.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "text-data-tools"
-  s.version = "1.0.6"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Edmund Highcock"]
@@ -14,7 +14,8 @@ Gem::Specification.new do |s|
   s.email = "edmundhighcock@sourceforge.net"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.rdoc",
+    "README.rdoc.orig"
   ]
   s.files = [
     ".document",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: text-data-tools
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -83,6 +83,7 @@ extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
+- README.rdoc.orig
 files:
 - .document
 - Gemfile
@@ -96,6 +97,7 @@ files:
 - test/test_dat_2.dat
 - test/test_text-data-tools.rb
 - text-data-tools.gemspec
+- README.rdoc.orig
 homepage: http://github.com/edmundhighcock/text-data-tools
 licenses:
 - GPLv3
@@ -111,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 476875355855839368
+      hash: 534969954448089810
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: