fixy 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d897c37235240b3fc2a84c136fcd3cc0bcb77040
-  data.tar.gz: f71f5072d0b9eadc315ee23d06326d97c39ec987
+  metadata.gz: 3af7502122c5bc3bcc6284ad25a631310925775a
+  data.tar.gz: 2caed3c7e83e9f70bcbb6bde57069021891e21cb
 SHA512:
-  metadata.gz: 0b5c8b72616560961fe6bcfcadce4f5422a1801731190c74c4f94b97df8399665051005159132c4cb5371ae0c839177814c5339984dcb0a2e2d54f839c425e40
-  data.tar.gz: 4068c6f9b3d9fd9aabfc0120de7d818a3a49f4099f26acfeda0bf9d799fcf424ca3f6111f8c254a2a7ad8f5303f7a82331ff43c277587b25237f520569608bbd
+  metadata.gz: c160c295dfb163a34260470a11e1c54fc39c9f9796ca1deef9d19f54637a13c534fa5ebe1155f16363104b36850b579bb6a40ed778f4e245a7d6a40b31d1a35a
+  data.tar.gz: 1348d95b39d809752cbfe47729ec4e6631fdb9bfda256ec6eea955589ab739c157324bfd023504fc1814c334083f4f39c99b1321eb11db2e636a8f58244fb0cf

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.0.7
+
+* Added support for custom line ending.
+
 ## v0.0.6
 
 * Support for multi-byte record parsing

data/README.md

@@ -36,6 +36,7 @@ A fixed-width document (`Fixy::Document`) is composed of multiple single-line re
 Every record is defined through a specific format, which defines the following aspects:
 
 * Record length (how many characters in the line)
+* Line ending (optional, defaults to "\n")
 * Required formatters (e.g. Alphanumeric, Rate, Amount)
 * Field declaration:
 	* Field human readable name
@@ -93,6 +94,11 @@ You can also specify the field definition and field value together by passing a
 
 field(:first_name, 10, '1-10', :alphanumeric) { @first_name }
 ```
+If a record requires a specific line ending, you can specify it as part of the Record definition.
+
+```ruby
+  set_line_ending Fixy::Record::LINE_ENDING_CRLF
+```
 
 Given a record definition, you can generate a single line (e.g. for testing purposes):
 

data/lib/fixy/record.rb

@@ -1,10 +1,19 @@
 module Fixy
   class Record
+    LINE_ENDING_LF = "\n".freeze
+    LINE_ENDING_CR = "\r".freeze
+    LINE_ENDING_CRLF = "#{LINE_ENDING_CR}#{LINE_ENDING_LF}".freeze
+    DEFAULT_LINE_ENDING = LINE_ENDING_LF
+
     class << self
       def set_record_length(count)
         define_singleton_method('record_length') { count }
       end
 
+      def set_line_ending(character)
+        @line_ending = character
+      end
+
       def field(name, size, range, type)
         @record_fields ||= default_record_fields
         range_matches = range.match /^(\d+)(?:-(\d+))?$/
@@ -55,6 +64,11 @@ module Fixy
         @record_fields
       end
 
+      def line_ending
+        # Use the default line ending unless otherwise specified
+        @line_ending || DEFAULT_LINE_ENDING
+      end
+
       def default_record_fields
         if superclass.respond_to?(:record_fields, true) && superclass.record_fields
           superclass.record_fields.dup
@@ -98,7 +112,7 @@ module Fixy
         end
 
         # Documentation mandates that every record ends with new line.
-        output << "\n"
+        output << line_ending
 
         { fields: fields, record: decorator.record(output) }
       end
@@ -128,7 +142,7 @@ module Fixy
       end
 
       # Documentation mandates that every record ends with new line.
-      output << "\n"
+      output << line_ending
 
       # All ready. In the words of Mr. Peters: "Take it and go!"
       decorator.record(output)
@@ -145,5 +159,10 @@ module Fixy
     def record_fields
       self.class.record_fields
     end
+
+    # Retrieves the line ending for this record type
+    def line_ending
+      self.class.line_ending
+    end
   end
 end

data/lib/fixy/version.rb

@@ -1,3 +1,3 @@
 module Fixy
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/fixy/record_spec.rb

@@ -10,6 +10,8 @@ describe 'Defining a Record' do
 
           set_record_length 20
 
+          set_line_ending Fixy::Record::LINE_ENDING_CRLF
+
           field :first_name, 10, '1-10' , :alphanumeric
           field :last_name , 10, '11-20', :alphanumeric
         end
@@ -185,6 +187,19 @@ describe 'Generating a Record' do
       PersonRecordJ.new.generate.should eq('Use My Value'.ljust(20) << "\n")
     end
   end
+
+  context 'when setting a line ending' do
+    class PersonRecordWithLineEnding < Fixy::Record
+      include Fixy::Formatter::Alphanumeric
+      set_record_length 20
+      set_line_ending Fixy::Record::LINE_ENDING_CRLF
+      field(:description , 20, '1-20', :alphanumeric) { 'Use My Value' }
+    end
+
+    it 'uses the given line ending' do
+      PersonRecordWithLineEnding.new.generate.should eq('Use My Value'.ljust(20) << "\r\n")
+    end
+  end
 end
 
 describe 'Parsing a record' do
@@ -207,6 +222,18 @@ describe 'Parsing a record' do
     end
   end
 
+  context 'with custom line endings' do
+    let(:record) { "Use My Value        " }
+    it 'should generate fixed width record' do
+      PersonRecordWithLineEnding.parse(record).should eq({
+        record: (record + Fixy::Record::LINE_ENDING_CRLF),
+        fields: [
+          { name: :description,  value: 'Use My Value        '}
+        ]
+      })
+    end
+  end
+
   context 'when properly defined' do
     let(:record) { "Sarah     Kerrigan  " }
     class PersonRecordK < Fixy::Record

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: fixy
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Omar Skalli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Library for generating fixed width flat files.
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -90,17 +90,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Provides a DSL for defining, generating, and debugging fixed width documents.