map-fields 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1.0 / 2009-06-02
+
+* Initial release

data/README.rdoc

@@ -0,0 +1,107 @@
+= map-fields
+
+* http://github.com/internuity/map-fields
+
+== DESCRIPTION:
+
+A Rails plugin which provides a hook to preview and map the fields of an uploaded CSV file to a pre-defined schema
+
+== FEATURES/PROBLEMS:
+
+* Captures the post and provides an intermediate view where a user can map their data to the expected schema
+* Provides a default mapping view that can be customised
+* Allows the import to be part of a larger form (The form fields are remembered through the mapping)
+
+== SYNOPSIS:
+
+  ===Lists controller
+    class ListsController < AppliactionController
+      map_fields :create, ['Title', 'First name', 'Last name'], :file_field => :file, :params => [:list]
+
+      def index
+        @lists = List.find(:all)
+      end
+
+      def new
+        @list = List.new
+      end
+
+      def create
+        @list = List.new(params[:list])
+        if fields_mapped?
+          mapped_fields.each do |row|
+            @list.contact.create(:title => row[0], 
+                                 :first_name => row[1], 
+                                 :last_name => row[2])
+          end
+          flash[:notice] = 'Contact list created'
+          redirect_to :action => :index
+        else
+          render
+        end
+      rescue MapFields::InconsistentStateError
+        flash[:error] = 'Please try again'
+        redirect_to :action => :new
+      rescue MapFields::MissingFileContentsError
+        flash[:error] = 'Please upload a file'
+        redirect_to :action => :new
+      end
+    end
+
+  ===New view (new.html.erb)
+    <h1>Import a new List</h1>
+    <% form_for :list, :html => {:multipart => true} do |form| %>
+      <div class="field">
+        <%= form.label :name %>
+        <%= form.text_field :name %>
+      </div>
+      <div class="field">
+        <label for="file">File</label>
+        <%= file_field_tag 'file' %>
+      </div>
+      <div class="buttons">
+        <%= form.submit 'Import' %>
+      </div>
+    <% end %>
+
+  ===Create view (create.html.erb)
+    <h1>Import a new List</h1>
+    <p>Please map the details you're importing</p>
+    =render :partial => 'map_fields/map_fields'
+
+== REQUIREMENTS:
+
+* FasterCSV
+
+== INSTALL:
+
+sudo gem install map-fields
+
+or
+
+./script/plugin install git://github.com/internuity/map-fields.git
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009
+
+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/init.rb

@@ -0,0 +1 @@
+require 'map_fields'

data/lib/map_fields.rb

@@ -0,0 +1,164 @@
+require 'fastercsv'
+
+module MapFields
+  VERSION = '1.0.0'
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def map_fields
+    default_options = {
+      :file_field => 'file',
+      :params => []
+    }
+    options = default_options.merge( 
+                self.class.read_inheritable_attribute(:map_fields_options)
+              )
+
+    if session[:map_fields].nil? || params[options[:file_field]]
+      session[:map_fields] = {}
+      if params[options[:file_field]].blank?
+        @map_fields_error = MissingFileContentsError
+        return
+      end
+
+      file_field = params[options[:file_field]]
+
+      temp_path = File.join(Dir::tmpdir, "map_fields_#{Time.now.to_i}_#{$$}")
+      File.open(temp_path, 'wb') do |f|
+        f.write file_field.read
+      end
+
+      session[:map_fields][:file] = temp_path
+
+      @rows = []
+      FasterCSV.foreach(temp_path) do |row|
+        @rows << row
+        break if @rows.size == 10
+      end
+      expected_fields = self.class.read_inheritable_attribute(:map_fields_fields)
+      @fields = ([nil] + expected_fields).inject([]){ |o, e| o << [e, o.size]}
+      @parameters = []
+      options[:params].each do |param|
+        @parameters += ParamsParser.parse(params, param)
+      end
+    else
+      if session[:map_fields][:file].nil? || params[:fields].nil?
+        session[:map_fields] = nil
+        @map_fields_error =  InconsistentStateError
+      else
+        @mapped_fields = MappedFields.new(session[:map_fields][:file], 
+                                          params[:fields],
+                                          params[:ignore_first_row])
+      end
+    end
+  end
+
+  def mapped_fields
+    @mapped_fields
+  end
+
+  def fields_mapped?
+    raise @map_fields_error if @map_fields_error
+    @mapped_fields
+  end
+
+  def map_field_parameters(&block)
+    
+  end
+
+  def map_fields_cleanup
+    if @mapped_fields
+      if session[:map_fields][:file]
+        File.delete(session[:map_fields][:file]) 
+      end
+      session[:map_fields] = nil
+      @mapped_fields = nil
+      @map_fields_error = nil
+    end
+  end
+
+  module ClassMethods
+    def map_fields(action, fields, options = {})
+      write_inheritable_array(:map_fields_fields, fields)
+      write_inheritable_attribute(:map_fields_options, options)
+      before_filter :map_fields, :only => action
+      after_filter :map_fields_cleanup, :only => action
+    end
+  end
+
+  class MappedFields
+    def initialize(file, mapping, ignore_first_row)
+      @file = file
+      @mapping = {}
+      @ignore_first_row = ignore_first_row
+      mapping.each do |k,v|
+        @mapping[v.to_i - 1] = k.to_i - 1 unless v.to_i == 0
+      end
+    end
+
+    def each
+      row_number = 1
+      FasterCSV.foreach(@file) do |csv_row|
+        unless row_number == 1 && @ignore_first_row
+          row = []
+          @mapping.each do |k,v|
+            row[k] = csv_row[v]
+          end
+          row.class.send(:define_method, :number) { row_number }
+          yield(row)
+        end
+        row_number += 1
+      end
+    end
+  end
+
+  class InconsistentStateError < StandardError
+  end
+
+  class MissingFileContentsError < StandardError
+  end
+
+  class ParamsParser
+    def self.parse(params, field = nil)
+      result = []
+      params.each do |key,value|
+        if field.nil? || field.to_s == key.to_s
+          check_values(value) do |k,v|
+            result << ["#{key.to_s}#{k}", v]
+          end
+        end
+      end
+      result
+    end
+
+    private
+    def self.check_values(value, &block)
+      result = []
+      if value.kind_of?(Hash)
+        value.each do |k,v|
+          check_values(v) do |k2,v2|
+            result << ["[#{k.to_s}]#{k2}", v2]
+          end
+        end
+      elsif value.kind_of?(Array)
+        value.each do |v|
+          check_values(v) do |k2, v2|
+            result << ["[]#{k2}", v2]
+          end
+        end
+      else
+        result << ["", value]
+      end
+      result.each do |arr|
+        yield arr[0], arr[1]
+      end
+    end
+  end
+end
+
+if defined?(Rails) and defined?(ActionController)
+  ActionController::Base.send(:include, MapFields)
+  ActionController::Base.view_paths.push File.expand_path(File.join(File.dirname(__FILE__), '..', 'views'))
+end

data/tasks/ann.rake

@@ -0,0 +1,80 @@
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/bones.rake

@@ -0,0 +1,20 @@
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,201 @@
+
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+end  # namespace :gem
+
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+remove_desc_for_task 'gem:clobber_package'
+
+# EOF