file_generator 0.0.2 → 0.0.3

data/ChangeLog

@@ -0,0 +1,9 @@
+2012-02-07 Martin Aceto <martin.aceto@gmail.com>
+
+* added more documentation in readme
+* inner class definition ''class << self''
+
+2012-02-06 Martin Aceto <martin.aceto@gmail.com>
+
+* First version v 0.0.1
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) Martin Aceto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -2,34 +2,37 @@
 
 ## Description
 
-Every time we need to generate text files for our applications, we are 
+Every time we need to export information from your application as text files, we are
 writing code for every format we need to generate.
 
-FileGenerator tries to minimize the ammount of code needed to perform
-this task.
+FileGenerator tries to minimize the ammount of code needed to perform this task.
 
-# How does it work?
+## 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
+each column has the next attributes
 
+* Name: this name would match with the key in the hash
+* Length: size of the column
+* Value: dafult value in case that name doesn't match with any hash key
+* Fill: for completing the space of length
+* Align: align to Left or Right
 
 as for instance:
 
-body format "id:3:0:0:D,name:30:: :I,region_id:3:0:0:D"
-
+<pre>
+"id:3:0:0:D,name:30:: :I,region_id:3:0:0:D"
+</pre>
 
 and the data we want to export is:
 
+<pre>
 [{"id"=>1, "region_id"=>7, "name"=>"les Escaldes"},{"id"=>2, "region_id"=>7, "name"=>"Lima"}]
+</pre>
 
 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
@@ -39,9 +42,68 @@ format.
 It also has names for the format which stablishes a special field as for
 instance:
 
-time: puts the current date with the format "·$"·$"·
+time: puts the current date with the format "YYYYMMDD"·
 
-nreg : put the ammount of records in the file in the body
+nreg : put the sum of records in the file in the body
 
 ## Usage
 
+For example if you have a Ruby on Rails application and you need to export
+diferents models like City, Region, Localities, Contacts, etc... you could define a controller Exports and for each model a method to export. Like the next example:
+
+Add file_generator to your Gemfile.
+
+<pre>
+  gem 'file_generation'
+</pre>
+
+Create the method in the Exports controller for generate the file
+
+<pre>
+class ExportsController
+  def cities
+    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"
+    cities = [{"id"=>1, "region_id"=>7, "name"=>"les Escaldes"},{"id"=>2, "region_id"=>7, "name"=>"Lima"}]
+    content = FileGenerator::Base.generate_file(cities, headerformat, bodyformat, footerformat)
+    send_data content, :filename => "cities.txt"
+  end
+
+  def contacts
+    ...
+  end
+
+end
+</pre>
+
+Add the routes in config/routes.rb
+
+<pre>
+resources :exports do
+  get 'cities', :on => :collection
+end
+</pre>
+
+and put the link in the view
+
+<pre>
+link_to("Export Cities", cities_exports_path)
+</pre>
+
+with this example you would get a file like this
+
+<pre>
+CC19320120206
+001les Escaldes                  007
+002Lima                          007
+CC1930000000002
+</pre>
+
+
+# what next ?
+
+* Make header and footer optional
+* Add .csv format like a option
+* Add more pre defined columns like "nreg" or "time"
+* Add more format for the pre defined column "time"

data/lib/file_generator/base.rb

@@ -26,24 +26,8 @@ module FileGenerator
         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
+          value = fixed_field(behaviors[0], behaviors[2], records)
+          row << justify_and_fill(value, behaviors[1],behaviors[3],behaviors[4])
         end
         row
       end
@@ -57,26 +41,50 @@ module FileGenerator
           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
+            value = fixed_field(behaviors[0], behaviors[2])
           end
+          row << justify_and_fill(value, behaviors[1],behaviors[3],behaviors[4])
         end
         row
       end
 
+      # Justify and fill
+      #
+      # I = Left
+      #
+      # D = rgiht
+      #
+      # fill = character in the format
+      #
+      def justify_and_fill(value,lenght, fill, justify)
+        if !fill.empty?
+          if justify == 'I'
+            value.ljust(lenght.to_i, fill)
+          elsif justify == 'D'
+            value.rjust(lenght.to_i, fill)
+          end
+        else
+          value
+        end
+      end
+
+      # take the name of the fixed_field and replace with the value
+      #
+      # time: replace with the date of the day in the formar %Y%m&d
+      #
+      # neg: if records is not nil count and replace with the value
+      #
+      def fixed_field(field, default, records = nil)
+        case field
+          when 'time'
+            Time.now.strftime("%Y%m%d")
+          when 'nreg' then
+            records.size.to_s unless records.nil?
+          else
+            default
+        end
+      end
+
       # split the format in each behaviors
       def split_format(format)
         format.split(',')

data/lib/file_generator/version.rb

@@ -1,3 +1,3 @@
 module FileGenerator
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/file_generator_spec.rb

@@ -7,7 +7,21 @@ describe FileGenerator do
       records = [{"id"=>1, "region_id"=>7, "name"=>"les Escaldes"},{"id"=>2, "region_id"=>7, "name"=>"Lima"}]
       format = load_formats.formats
       FileGenerator::Base.generate_file(records,format['headerformat'],format['bodyformat'],format['footerformat'])
-      #raise f.generate_file(records,format['headerformat'],format['bodyformat'],format['footerformat']).inspect
+    end
+
+    it "gets a good format path format should not be empty" do
+      format = load_formats.formats
+      format.should_not be_empty
+    end
+
+    it "gets a good format path format should match" do
+      format = load_formats.formats
+      format.should == {'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'}
+    end
+
+    it "gets a bad format path shuold show up a message" do
+      format = load_formats("/spec/formt.yml")
+      format.should == "missing formats file."
     end
 
     it "should not be empty string" do

data/spec/spec_helper.rb

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

data/spec/support/helpers.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-20 00:00:00.000000000 Z
 dependencies: []
 description: Generator of files using a format description
 email:
@@ -19,7 +19,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- ChangeLog
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - file_generator.gemspec