file_generator 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.rbc
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in file_generator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# file_generator
+
+## Description
+
+Every time we need to generate text files for our applications, we are 
+writing code for every format we need to generate.
+
+FileGenerator tries to minimize the ammount of code needed to perform
+this task.
+
+# How does it work?
+
+FileGenerator takes the header, body, and footer file formats as input
+and additionally a hash with the data we want to export.
+
+The format is expressed as string as follows:
+
+0 => nombre
+1 => longitud
+2 => valor
+3 => relleno
+4 => alineado
+
+
+as for instance:
+
+body format "id:3:0:0:D,name:30:: :I,region_id:3:0:0:D"
+
+
+and the data we want to export is:
+
+[{"id"=>1, "region_id"=>7, "name"=>"les Escaldes"},{"id"=>2, "region_id"=>7, "name"=>"Lima"}]
+
+FileGenerator will try to match the attribute names with the format
+names, if they dont match, it will assign the value to the line of the
+file to export, otherwise it will take the default value defined in the
+format.
+
+It also has names for the format which stablishes a special field as for
+instance:
+
+time: puts the current date with the format "·$"·$"·
+
+nreg : put the ammount of records in the file in the body
+
+## Usage
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/file_generator.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "file_generator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "file_generator"
+  s.version     = FileGenerator::VERSION
+  s.authors     = ["Martin Aceto"]
+  s.email       = ["martin.aceto@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Generator of files using a format description}
+  s.description = %q{Generator of files using a format description}
+
+  s.rubyforge_project = "file_generator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/file_generator/base.rb

@@ -0,0 +1,91 @@
+module FileGenerator
+  class Base
+
+    def initialize()
+    end
+
+    def generate_file(records, headerformat, bodyformat, footerformat)
+      file = []
+      fh = process_hf(headerformat, records)
+      file << fh
+      records.each do |record|
+        fb = process_body(bodyformat, record)
+        file << fb
+      end
+      ff = process_hf(footerformat, records)
+      file << ff
+      file = file.join("\n")
+      file
+    end
+
+    private
+
+    def process_hf(format, records)
+      row = ''
+      attributes = split_format(format)
+      attributes.each do |attrib|
+        behaviors = split_behaviors(attrib) # 0=>nombre, 1=>longitud, 2=> valor, 3=> relleno, 4 => alineado
+        value = ''
+        case behaviors[0]
+          when 'nreg' then
+            value = records.size.to_s
+          when 'time' then
+            value = Time.now.strftime("%Y%m%d")
+          else
+            value = behaviors[2]
+        end
+        if (behaviors[3] != '')
+          if (behaviors[4] == 'I')
+            row << value.ljust(behaviors[1].to_i, behaviors[3])
+          else
+            row << value.rjust(behaviors[1].to_i, behaviors[3])
+          end
+        else
+          row << value
+        end
+      end
+      row
+    end
+
+    def process_body(format, record)
+      row = ''
+      attributes = split_format(format)
+      attributes.each do |attrib|
+        behaviors = split_behaviors(attrib) # 0=>nombre, 1=>longitud, 2=> valor, 3=> relleno, 4 => alineado
+        value = ''
+        if record.has_key?(behaviors[0])
+          value = record["#{behaviors[0]}"].to_s
+        else
+          case behaviors[0]
+            when 'time' then
+              value = Time.now.strftime("%Y%m%d")
+            else
+              value = behaviors[2]
+          end
+        end
+        if (behaviors[3] != '')
+          if (behaviors[4] == 'I')
+            row << value.ljust(behaviors[1].to_i, behaviors[3])
+          else
+            row << value.rjust(behaviors[1].to_i, behaviors[3])
+          end
+        else
+          row << value
+        end
+      end
+      row
+    end
+
+    # split the format in each behaviors
+    def split_format(format)
+      format.split(',')
+    end
+
+    # split the line pased
+    # 0=>nombre, 1=>longitud, 2=> valor, 3=> relleno, 4 => alineado
+    def split_behaviors(behavior)
+      behavior.split(':')
+    end
+
+  end
+end

data/lib/file_generator/version.rb

@@ -0,0 +1,3 @@
+module FileGenerator
+  VERSION = "0.0.1"
+end

data/lib/file_generator.rb

@@ -0,0 +1,6 @@
+require "file_generator/version"
+require "file_generator/base"
+
+module FileGenerator
+
+end

data/spec/formats.yml

@@ -0,0 +1,5 @@
+# 0=>nombre, 1=>longitud, 2=> valor, 3=> relleno, 4 => alineado
+formats:
+  headerformat: "treg:2:CC::I,csuc:3:193::I,time:8:0::I"
+  bodyformat: "id:3:0:0:D,name:30:: :I,region_id:3:0:0:D"
+  footerformat: "pie:2:CC::I,csuc:3:193::I,nreg:10:0:0:D"

data/spec/lib/file_generator_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe FileGenerator do
+  context "generating file" do
+
+    let(:file_generator) do
+      records = [{"id"=>1, "region_id"=>7, "name"=>"les Escaldes"},{"id"=>2, "region_id"=>7, "name"=>"Lima"}]
+      format = load_formats.formats
+      f = FileGenerator::Base.new
+      f.generate_file(records,format['headerformat'],format['bodyformat'],format['footerformat'])
+      #raise f.generate_file(records,format['headerformat'],format['bodyformat'],format['footerformat']).inspect
+    end
+
+    it "should not be empty string" do
+      file_generator.should_not be_empty
+    end
+
+    it "header should be match the format" do
+      header = file_generator.split("\n")[0]
+      header.should match "CC193" + Time.now.strftime("%Y%m%d").to_s
+    end
+
+    it "footer should be match the format" do
+      footer = file_generator.split("\n")[3]
+      footer.should match "CC1930000000002"
+    end
+
+    it "first line body should be match format" do
+      body = file_generator.split("\n")[1]
+      body.should match "001les Escaldes                  007"
+    end
+
+    it "second line body should be match format" do
+      body = file_generator.split("\n")[2]
+      body.should match "002Lima                          007"
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'file_generator'
+require 'rspec'
+
+Dir[File.join(Dir.pwd, "spec/support/**/*.rb")].each {|f| require f}
+

data/spec/support/helpers.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+require "yaml"
+
+module Helpers
+
+  def load_formats
+    formats_file = File.join(Dir.pwd, "/spec/formats.yml")
+    if File.exists?(formats_file)
+      conf = YAML.load(File.read("#{Dir.pwd}/spec/formats.yml"))
+      OpenStruct.new(conf)
+    else
+      raise "missing formats file. "
+    end
+  end
+
+end
+
+RSpec.configuration.include Helpers
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: file_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Martin Aceto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-06 00:00:00.000000000 Z
+dependencies: []
+description: Generator of files using a format description
+email:
+- martin.aceto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- file_generator.gemspec
+- lib/file_generator.rb
+- lib/file_generator/base.rb
+- lib/file_generator/version.rb
+- spec/formats.yml
+- spec/lib/file_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: file_generator
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Generator of files using a format description
+test_files:
+- spec/formats.yml
+- spec/lib/file_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb