@@ -46,6 +46,8 @@ A simple, clean DSL for describing, writing, and parsing fixed-width text files. end end +Supported types are: string, integer, date, float, money, and money_with_implied_decimal. + Then either feed it a nested struct with data values to create the file in the defined format: test_data = { README.rdoc @@ -24,7 +24,7 @@ PROJ.name = 'slither' PROJ.authors = 'Ryan Wood' PROJ.email = 'ryan.wood@gmail.com' PROJ.url = 'http://github.com/ryanwood/slither' -PROJ.version = '0.99.0' +PROJ.version = '0.99.1' PROJ.exclude = %w(\.git .gitignore ^tasks \.eprj ^pkg) PROJ.readme_file = 'README.rdoc' Rakefile @@ -1,4 +1,4 @@ --- -:minor: 0 +:minor: 1 :patch: 99 :major: 0 VERSION.yml @@ -20,13 +20,15 @@ class Slither "A#{@length}" end - def to_type(value) + def parse(value) case @type when :integer: value.to_i - when :float: value.to_f + when :float, :money: value.to_f + when :money_with_implied_decimal: + value.to_f / 100 when :date: - if @options[:date_format] - Date.strptime(value, @options[:date_format]) + if @options[:format] + Date.strptime(value, @options[:format]) else Date.strptime(value) end @@ -35,13 +37,15 @@ class Slither end def format(value) - pad(formatter % format_as_string(value)) + pad(formatter % to_s(value)) + rescue + puts "Could not format column '#{@name}' as a '#{@type}' with formatter '#{formatter}' and value of '#{value}' (formatted: '#{to_s(value)}'). #{$!}" end private def formatter - "%#{aligner}#{sizer}#{typer}" + "%#{aligner}#{sizer}s" end def aligner @@ -52,14 +56,6 @@ class Slither (@type == :float && @precision) ? @precision : @length end - def typer - case @type - when :integer: 'd' - when :float: 's' - else 's' - end - end - # Manually apply padding. sprintf only allows padding on numeric fields. def pad(value) return value unless @padding == :zero @@ -69,19 +65,34 @@ class Slither value.gsub(space[0], '0' * space[0].size) end - def format_as_string(value) + def to_s(value) result = case @type - when :date: - if @options[:date_format] - value.strftime(@options[:date_format]) + when :date: + # If it's a DBI::Timestamp object, see if we can convert it to a Time object + unless value.respond_to?(:strftime) + value = value.to_time if value.respond_to?(:to_time) + end + if value.respond_to?(:strftime) + if @options[:format] + value.strftime(@options[:format]) + else + value.strftime + end else - value.strftime + value.to_s end - else value.to_s + when :float: + @options[:format] ? @options[:format] % value.to_f : value.to_f.to_s + when :money: + "%.2f" % value.to_f + when :money_with_implied_decimal: + "%d" % (value.to_f * 100) + else + value.to_s end raise( Slither::FormattedStringExceedsLengthError, - "The formatted value '#{result}' exceeds #{@length} chararacters, the allowable length of the '#{@name}' column." + "The formatted value '#{result}' in column '#{@name}' exceeds the allowed length of #{@length} chararacters." ) if result.length > @length result end lib/slither/column.rb @@ -50,7 +50,7 @@ class Slither line_data = line.unpack(unpacker) row = {} @columns.each_with_index do |c, i| - row[c.name] = c.to_type(line_data[i]) unless RESERVED_NAMES.include?(c.name) + row[c.name] = c.parse(line_data[i]) unless RESERVED_NAMES.include?(c.name) end row end lib/slither/section.rb @@ -6,6 +6,7 @@ class Slither class RequiredSectionNotFoundError < StandardError; end class RequiredSectionEmptyError < StandardError; end class FormattedStringExceedsLengthError < StandardError; end + class ColumnMismatchError < StandardError; end def self.define(name, options = {}, &block) lib/slither/slither.rb @@ -60,73 +60,55 @@ describe Slither::Column do it "should return the proper unpack value for a string" do @column.send(:unpacker).should == 'A5' end - - describe "when typing the value" do + + describe "when parsing a value from a file" do it "should default to a string" do - @column.to_type('name').should == 'name' + @column.parse(' name ').should == 'name' + @column.parse(' 234').should == '234' + @column.parse('000000234').should == '000000234' + @column.parse('12.34').should == '12.34' end - - it "should support the :integer type" do - @column = Slither::Column.new(@name, @length, :type => :integer) - @column.to_type('234').should == 234 + + it "should support the integer type" do + @column = Slither::Column.new(:amount, 10, :type=> :integer) + @column.parse('234 ').should == 234 + @column.parse(' 234').should == 234 + @column.parse('00000234').should == 234 + @column.parse('Ryan ').should == 0 + @column.parse('00023.45').should == 23 end - it "should support the :float type" do - @column = Slither::Column.new(@name, @length, :type => :float) - @column.to_type('234.45').should == 234.45 - end + it "should support the float type" do + @column = Slither::Column.new(:amount, 10, :type=> :float) + @column.parse(' 234.45').should == 234.45 + @column.parse('234.5600').should == 234.56 + @column.parse(' 234').should == 234.0 + @column.parse('00000234').should == 234.0 + @column.parse('Ryan ').should == 0 + @column.parse('00023.45').should == 23.45 + end + + it "should support the money_with_implied_decimal type" do + @column = Slither::Column.new(:amount, 10, :type=> :money_with_implied_decimal) + @column.parse(' 23445').should == 234.45 + end - it "should support the :date type" do - @column = Slither::Column.new(@name, @length, :type => :date) - dt = @column.to_type('2009-08-22') + it "should support the date type" do + @column = Slither::Column.new(:date, 10, :type => :date) + dt = @column.parse('2009-08-22') dt.should be_a(Date) dt.to_s.should == '2009-08-22' end - it "should use the :date_format option with :date type if available" do - @column = Slither::Column.new(@name, @length, :type => :date, :date_format => "%m%d%Y") - dt = @column.to_type('08222009') + it "should use the format option with date type if available" do + @column = Slither::Column.new(:date, 10, :type => :date, :format => "%m%d%Y") + dt = @column.parse('08222009') dt.should be_a(Date) dt.to_s.should == '2009-08-22' end end - describe "when getting the column's the value as a string" do - it "should default to a string" do - @column.send(:format_as_string, 'name').should == 'name' - end - - it "should raise an error if the value is longer than the length" do - lambda { @column.send(:format_as_string, 'This string is too long') }.should raise_error( - Slither::FormattedStringExceedsLengthError, - "The formatted value 'This string is too long' exceeds #{@length} chararacters, the allowable length of the '#{@name}' column." - ) - end - - it "should support the :integer type" do - @column = Slither::Column.new(@name, @length, :type => :integer) - @column.send(:format_as_string, 234).should == '234' - end - - it "should support the :float type" do - @column = Slither::Column.new(:amount, 6, :type => :float) - @column.send(:format_as_string, 234.45).should == '234.45' - end - - it "should support the :date type" do - dt = Date.new(2009, 8, 22) - @column = Slither::Column.new(:date, 10, :type => :date) - @column.send(:format_as_string, dt).should == '2009-08-22' - end - - it "should use the :date_format option with :date type if available" do - dt = Date.new(2009, 8, 22) - @column = Slither::Column.new(:date, 8, :type => :date, :date_format => "%m%d%Y") - @column.send(:format_as_string, dt).should == '08222009' - end - end - - describe "when formatting a column" do + describe "when applying formatting options" do it "should return a proper formatter" do @column = Slither::Column.new(@name, @length, :align => :left) @column.send(:formatter).should == "%-5s" @@ -162,6 +144,68 @@ describe Slither::Column do @column = Slither::Column.new(@name, @length, :type => :float, :padding => :zero, :align => :left) @column.format(4.45).should == '4.450' end + end + end + + describe "when formatting values for a file" do + it "should default to a string" do + @column = Slither::Column.new(:name, 10) + @column.format('Bill').should == ' Bill' + end + + it "should raise an error if the value is longer than the length" do + @value = "XX" * @length + lambda { @column.format(@value) }.should raise_error( + Slither::FormattedStringExceedsLengthError, + "The formatted value '#{@value}' in column '#{@name}' exceeds the allowed length of #{@length} chararacters." + ) + end + + it "should support the integer type" do + @column = Slither::Column.new(:amount, 10, :type => :integer) + @column.format(234).should == ' 234' + @column.format('234').should == ' 234' end + + it "should support the float type" do + @column = Slither::Column.new(:amount, 10, :type => :float) + @column.format(234.45).should == ' 234.45' + @column.format('234.4500').should == ' 234.45' + @column.format('3').should == ' 3.0' + end + + it "should support the float type with a format" do + @column = Slither::Column.new(:amount, 10, :type => :float, :format => "%.3f") + @column.format(234.45).should == ' 234.450' + @column.format('234.4500').should == ' 234.450' + @column.format('3').should == ' 3.000' + end + + it "should support the float type with a format, alignment and padding" do + @column = Slither::Column.new(:amount, 10, :type => :float, :format => "%.2f", :align => :left, :padding => :zero) + @column.format(234.45).should == '234.450000' + @column = Slither::Column.new(:amount, 10, :type => :float, :format => "%.2f", :align => :right, :padding => :zero) + @column.format('234.400').should == '0000234.40' + @column = Slither::Column.new(:amount, 10, :type => :float, :format => "%.4f", :align => :left, :padding => :space) + @column.format('3').should == '3.0000 ' + end + + it "should support the money_with_implied_decimal type" do + @column = Slither::Column.new(:amount, 10, :type=> :money_with_implied_decimal) + @column.format(234.450).should == " 23445" + @column.format(12.34).should == " 1234" + end + + it "should support the date type" do + dt = Date.new(2009, 8, 22) + @column = Slither::Column.new(:date, 10, :type => :date) + @column.format(dt).should == '2009-08-22' + end + + it "should support the date type with a :format" do + dt = Date.new(2009, 8, 22) + @column = Slither::Column.new(:date, 8, :type => :date, :format => "%m%d%Y") + @column.format(dt).should == '08222009' + end end end \ No newline at end of file spec/column_spec.rb @@ -69,15 +69,6 @@ describe Slither::Parser do lambda { @parser.parse }.should raise_error(Slither::RequiredSectionNotFoundError, "Required section 'header' was not found.") end - it "raise an error if a section limit is over run" + # it "raise an error if a section limit is over run" end - - - - describe "when in linear mode" do - - end - - - end \ No newline at end of file spec/parser_spec.rb 37062d34979ad17a90452cffec67381097521a8a Ryan Wood ryan.wood@gmail.com http://github.com/ryanwood/slither/commit/d9a85792b8e96090f571cde61dd2aae213d4a301 d9a85792b8e96090f571cde61dd2aae213d4a301 2009-04-23T13:02:15-07:00 2009-04-23T13:02:15-07:00 Added better support for float formatting and money_with_implied_decimal types 4a67a6397bf953608220863d88f8eacce939ecc6 Ryan Wood ryan.wood@gmail.com