crhym3-imexport 0.1.2 → 0.1.3

data/CHANGELOG

@@ -1,3 +1,10 @@
-== 0.1.2
-* Adding support for models within a namespace (using eval() now).
+v0.1.3 (Aprile 29th, 2009)
+
+* Bugfixing (wasn't saving the last record). 
+* Adding :verbose option (see README.rdoc). 
+* ImExport::import() is now oboslete. Use ImExport::Import.from_file().
+
+v0.1.2 
+
+* Adding support for models within a namespace (using eval() now with a regexp).
 

data/README.rdoc

@@ -153,11 +153,12 @@ So, the complete rake task would look like this:
 Also, you can pass a block to ImExport::import. In that case you'll have to 
 call model.save or model.update_attributes(...) yourself:
 
-  ImExport::import(ENV['FROM_FILE'], { 
-                   :class_name        => 'Seminar', 
-                   :find_by           => 'title',
-                   :db_columns_prefix => 'COLUMN_',
-                   :map               => COLUMNS_TO_MODEL_MAP}) do |seminar|
+  ImExport::Import.from_file(ENV['FROM_FILE'], { 
+         :class_name        => 'Seminar', 
+         :find_by           => 'title',
+         :db_columns_prefix => 'COLUMN_',
+         :verbose           => false,
+         :map               => COLUMNS_TO_MODEL_MAP}) do |seminar|
                    
     # do something with seminar object here, e.g. 
     # seminar.save
@@ -182,6 +183,14 @@ call model.save or model.update_attributes(...) yourself:
   Column name prefix that should be skipped while looking for the corresponding
   model attribute name. Againg, considering previous example, +COLUMN_title+ 
   actually means +title+ attribute of +Seminar+ model.
+  
++verbose+::
+  +true+, +false+ or +Proc+.new { |model| }.
+  In cases where model.valid? returns false ImExport might output an error 
+  (WARNING) message. +Verbose+ option tells it whether do it or not. In case
+  +verbose+ is a Proc, the latter being passed the model in question and should
+  return +true+ or +false+. 
+  Default is +true+.
 
 +map+::
   Hash.
@@ -211,6 +220,10 @@ call model.save or model.update_attributes(...) yourself:
 
   sudo gem install crhym3-imexport
   
+If that fails execute the following and try it again.
+
+  gem sources -a http://gems.github.com/
+
 == License
 
 Copyright (c) 2009 Alex Vagin, released under the MIT license.

data/Rakefile

@@ -2,13 +2,17 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('imexport', '0.1.2') do |p|
+Echoe.new('imexport', '0.1.3') do |p|
   p.description     = "Simple import from a text file generated by mysql -E ..."
   p.url             = "http://github.com/crhym3/imexport"
   p.author          = "alex"
   p.email           = "alex@digns.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.development_dependencies = []
+  
+  # github can't sign gems, yet
+  p.certificate_chain = nil
+  p.private_key       = nil
 end
 
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/imexport.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{imexport}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["alex"]
-  s.date = %q{2009-04-28}
+  s.date = %q{2009-04-29}
   s.description = %q{Simple import from a text file generated by mysql -E ...}
   s.email = %q{alex@digns.com}
   s.extra_rdoc_files = ["CHANGELOG", "TODO", "lib/imexport.rb", "README.rdoc"]

data/lib/imexport.rb

@@ -1,107 +1,145 @@
 module ImExport
-  def self.import(file_name, options = {})
-    if options[:class_name] =~ /[^a-zA-Z\:]+/
-      raise "#{options[:class_name]} doesn't look like a class name"
-    end
-    
-    ## e.g. :seminar => "seminar" => "Seminar" => Seminar
-    model = eval(options[:class_name].to_s.classify)
-    
-    ## used to check for an existing record. so we do update_attributes()
-    # instead of save() in that case
-    find_method = "find_by_#{options[:find_by]}"
-    
-    ## helps to distinguish between real columns and column content
-    # could be something like "COLUMN_"
-    columns_prefix = options[:db_columns_prefix].to_s
-    
-    ## for each line, this is how we check for a new column or cont.
-    # from the previous line
-    scan_regexp = Regexp.new("^\\s*#{columns_prefix}(\\w+)\\: (.*)")
-    
-    ## table columns --> model attributes mapping
-    # if an attribute is not specified and present as a column,
-    # it'll try figure it out:
-    # { 'title' => :title } - works w/o expicit mapping
-    attr_map = options[:map] || {}
-    
-    ## Read the file
-    # we assume it's been created with vertial columns layout (mysql -E ...)
-    IO.foreach(file_name) do |line|
-      ## mysql -E ... does this:
-      # ********* 1. row **********
-      # column: value
-      # another_column: value
-      # ********* 2. row **********
-      unless (line =~ /^\*+ \d+\. row \*+$/).nil?
-        ## We've got a new row
-        unless block_given?
-          ## Save previously created object ...
-          if !@model.nil? and @model.valid?
-            if (s = model.send("#{find_method}", @model.title))
-              s.update_attributes(@model.attributes.reject{|k,v| v.nil?})
-            else
-              @model.save
-            end
-          else 
-            $stderr.puts "\n>>> ERRORS while storing #{options[:class_name]}: #{@model.errors.full_messages.join('; ')}\n#{@model.inspect}" unless @model.nil?
-          end
-        else
-          ## or pass it to a block
-          # in this case we don't do any validations
-          yield(@model)
-        end
-        
-        # ... then create a new one
-        #$stderr.puts "\n###################################"
-        @model = model.new
-        @last_column_name = nil
-        @last_column_content = nil
-        next
+  def self.import(file_name, options)
+    puts "WARNING: ImExport::import() method is obsolete.\nYou should use ImExport::Import.from_file() instead.\n"
+    Import.from_file file_name, options
+  end
+  
+  class Import
+    def self.from_file(file_name, options = {})
+      if options[:class_name] =~ /[^a-zA-Z\:]+/
+        raise "#{options[:class_name]} doesn't look like a class name"
       end
       
-      ## Cont. of the same row.
-      ## It's one table column at a time (or more lines).
-      ## Parse it and add set the corresponding attribute in the model
-      line.chomp!
-      column = line.scan(scan_regexp)
-      #$stderr.puts column.inspect
+      ## e.g. :seminar => "seminar" => "Seminar" => Seminar
+      model = eval(options[:class_name].to_s.classify)
       
-      unless column.size > 0
-        ## this is a column continuation of the previous line
-        @last_column_content << '<br/>' << line
-        next
-      end
+      ## used to check for an existing record. so we do update_attributes()
+      # instead of save() in that case
+      #
+      # Example:
+      # :find_by => :title # model.find_by_title
+      @@find_by_attribute = options[:find_by].to_s
+      
+      ## helps to distinguish between real columns and column content
+      # could be something like "COLUMN_"
+      columns_prefix = options[:db_columns_prefix].to_s
+      
+      ## for each line, this is how we check for a new column or cont.
+      # from the previous line
+      scan_regexp = Regexp.new("^\\s*#{columns_prefix}(\\w+)\\: (.*)")
       
-      ## this is a new model attribute
-      # set last attribute in the model if defined
-      # we should have at least two items in the array
-      column.flatten!
-      @last_column_name = column.first
-      @last_column_content = column[1].gsub(/\t+/, " ").strip.gsub(/^\n+$/, "").gsub(/\n+/, "<br/>")
+      ## table columns --> model attributes mapping
+      # if an attribute is not specified and present as a column,
+      # it'll try figure it out:
+      # { 'title' => :title } - works w/o expicit mapping
+      attr_map = options[:map] || {}
       
-      # in column-to-model map
-      if attr_map.include?(@last_column_name)
-        mattr = attr_map[@last_column_name]
-        case
-          when mattr.kind_of?(Symbol)
-            @model.send("#{mattr.to_s}=", @last_column_content)
-          when mattr.kind_of?(Proc)
-            mattr.call(@last_column_content, @model)
-          when mattr.kind_of?(Hash)
-            @model.send("#{mattr.keys.first}=", mattr.values.first.call(@last_column_content))
+      ## verbose option
+      # is a Proc type. Should return true or false.
+      # If true a warning message outputs to stderr in case !model.valid?
+      # 
+      # Example:
+      # verbose => Proc.new { |seminar| seminar.date.future? }
+      #
+      # verbose => nil or not specifying this options at all makes it silent
+      @@verbose = options.include?(:verbose) ? options[:verbose] : true # default is verbose
+      
+      ## Read the file
+      # we assume it's been created with vertial columns layout (mysql -E ...)
+      model_inst = nil
+      IO.foreach(file_name) do |line|
+        ## mysql -E ... does this:
+        # ********* 1. row **********
+        # column: value
+        # another_column: value
+        # ... 
+        # ********* 2. row **********
+        unless (line =~ /^\*+ \d+\. row \*+$/).nil?
+          ## We've got a new row
+          # save or update previously created object ...
+          unless block_given?
+            save_or_update(model_inst) if model_inst
           else
-            $stderr.puts "WARNING: don't know how to handle #{mattr.inspect}"
+            ## or pass it to a block
+            # in this case we don't do any validations
+            yield(model_inst)
+          end 
+          
+          # ... then create a new one
+          #$stderr.puts "\n###################################"
+          model_inst = model.new
+          @last_column_name = nil
+          @last_column_content = nil
+          next
+        end
+        
+        ## Cont. of the same row.
+        ## It's one table column at a time (or more lines).
+        ## Parse it and add set the corresponding attribute in the model
+        line.chomp!
+        column = line.scan(scan_regexp)
+        #$stderr.puts column.inspect
+        
+        unless column.size > 0
+          ## this is a column continuation of the previous line
+          @last_column_content << '<br/>' << line
+          next
         end
         
-      # simple auto-mapping  
-      elsif @model.respond_to?(@last_column_name.to_sym)
-        @model.send("#{@last_column_name}=", @last_column_content)
+        ## this is a new model attribute
+        # set last attribute in the model if defined
+        # we should have at least two items in the array
+        column.flatten!
+        @last_column_name = column.first
+        @last_column_content = column[1].gsub(/\t+/, " ").strip.gsub(/^\n+$/, "").gsub(/\n+/, "<br/>")
         
-      # otherwise we don't know how to do it
+        # in column-to-model map
+        if attr_map.include?(@last_column_name)
+          mattr = attr_map[@last_column_name]
+          case
+            when mattr.kind_of?(Symbol)
+              model_inst.send("#{mattr.to_s}=", @last_column_content)
+            when mattr.kind_of?(Proc)
+              mattr.call(@last_column_content, model_inst)
+            when mattr.kind_of?(Hash)
+              model_inst.send("#{mattr.keys.first}=", mattr.values.first.call(@last_column_content))
+            else
+              $stderr.puts "WARNING: don't know how to handle #{mattr.inspect}"
+          end
+          
+        # simple auto-mapping  
+        elsif model_inst.respond_to?("#{@last_column_name}=")
+          model_inst.send("#{@last_column_name}=", @last_column_content)
+          
+        # otherwise we don't know how to do it
+        else
+          $stderr.puts "WARNING: don't know how to set :#{@last_column_name}"
+        end
+      end # IO.foreach
+      
+      # TODO: more DRY
+      # save the last one
+      unless block_given?
+        save_or_update(model_inst) if model_inst
       else
-        $stderr.puts "WARNING: don't know how to set :#{@last_column_name}"
+        ## or pass it to a block
+        # in this case we don't do any validations
+        yield(model_inst)
       end
-    end # IO.foreach
-  end
+    end
+    
+    def self.save_or_update(model)
+      # save it if valid or say an error
+      if !model.nil? and model.valid?
+        if (s = model.class.send("find_by_#{@@find_by_attribute}", model.read_attribute(@@find_by_attribute)))
+          s.update_attributes(model.attributes.reject{|k,v| v.nil?})
+        else
+          model.save
+        end
+      elsif (@@verbose.kind_of?(Proc) ? @@verbose.call(model) : @@verbose)
+        $stderr.puts "\n>>> ERRORS while storing #{model.class.to_s}: #{model.errors.full_messages.join('; ')}\n#{model.inspect}" unless model.nil?
+      end
+    end
+  end # class Import
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: crhym3-imexport
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - alex
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-28 00:00:00 -07:00
+date: 2009-04-29 00:00:00 -07:00
 default_executable: 
 dependencies: []