rseed-roo 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTkyYjNjYTUzNzU4NjcwMjZjNTc1MzYyMzI3YzlkNjhjZDAyZGUyOA==
+  data.tar.gz: !binary |-
+    OTFjYTI3ZDI1MTNmYmQ3MjdkMjJkOWNmNmZlMjI2NDEwM2VkZTMwMw==
+SHA512:
+  metadata.gz: !binary |-
+    MzlhMTVmMTBhZDJjOGRiNjJlYjAwOTM2OWZiYmJhZmE4YTlkODc2MDFmMDNk
+    MmMyZDZjMWUwZmJmMmU3ZmM4Zjk0OGNjOWNlOTkwNjQ4MWM1MzI0ODk2YTUx
+    NGNkNzdhOTk3MjE3YTcwMjkwZjMyOGY0MDk4MzU5NTg3N2I4MTQ=
+  data.tar.gz: !binary |-
+    MjIyNzQ2YmU4OGZiMWM0NjQxMWE2NWE4OTJiZGViNDUyNzlmNGQzNGNiMDE0
+    ZDMyMDg5M2M5YmUyNjRjZjcwNTFhNDI4NDMxZGUxMmI3YWRiZGNmZTFkOTg0
+    Y2FkOWVmZTYxMDQxMzFlZjYyYzYxOTRlM2M5NTI2Mjc3ODllNzM=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rseed-roo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Monagle
+
+MIT License
+
+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.rdoc

@@ -0,0 +1,24 @@
+# Rseed::Roo
+
+This is an adapter for the Rseed gem http://github.com/intrica/rseed
+
+The RooAdapter allows you to import excel files using rseed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rseed-roo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rseed-roo
+
+## Usage
+
+The Roo adapter takes the same parameters as the CSV adapter that is built into Rseed. It also provides a *from_exel*
+helper that works just like the from_csv helper in Rseed.

data/Rakefile

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

data/lib/rseed/roo.rb

@@ -0,0 +1,15 @@
+require "rseed/roo/version"
+require "rseed/roo/roo_adapter"
+require "rseed/roo/helpers"
+
+module Rseed
+  module Roo
+    class Railtie < ::Rails::Railtie
+      railtie_name :rseed_roo
+
+      rake_tasks do
+        load "tasks/rseed-roo.rake"
+      end
+    end
+  end
+end

data/lib/rseed/roo/helpers.rb

@@ -0,0 +1,10 @@
+require 'colorize'
+
+module Rseed
+  def from_excel(file, options = {})
+    options[:adapter] = :roo
+    from_file(file, options)
+  end
+
+  module_function :from_excel
+end

data/lib/rseed/roo/roo_adapter.rb

@@ -0,0 +1,107 @@
+require "roo"
+
+module Rseed
+  class RooAdapter < Rseed::Adapter
+    attr_accessor :file
+
+    def preprocess
+      return false unless file
+      logger.info "Preprocessing Excel file: #{file.to_s.yellow}"
+
+      @excelx = false
+      case File.extname(file).downcase
+        when ".xls"
+          @roo = ::Roo::Excel.new(file)
+        when ".xlsx"
+          @excelx = true
+          @roo = ::Roo::Excelx.new(file)
+      end
+
+      result = find_excel_header_row
+
+      if result.nil?
+        logger.error "Could not find header row.".red
+        return false
+      end
+
+      @roo.default_sheet = result[:sheet]
+      @header_row = result[:row]
+      @headers = result[:headers]
+
+      true
+    end
+
+    def process &block
+      # Loop through the data
+      logger.info "Reading data from row #{@header_row + 1} to #{@roo.last_row}"
+      @estimated_rows =@roo.last_row - @header_row;
+      row_number = 0
+      (@header_row + 1).upto(@roo.last_row) do |row|
+        row_number += 1
+        import_row = {}
+        @headers.each_pair do |name, column|
+          if @excelx
+            value = @roo.cell(row, column).to_s
+          else
+            value = @roo.cell(row, column).to_s
+          end
+          import_row[name] = value
+        end
+        yield import_row, record_count: row_number, total_records: @estimated_rows
+      end
+    end
+
+    def all_headers_found(headers)
+      @missing_headers_mandatory = []
+      @missing_headers_optional = []
+      found_at_least_one = false
+
+      converter_attributes.each do |attribute|
+        if headers[attribute.name].nil?
+          unless mapping[:optional]
+            @missing_headers_mandatory << attribute.name
+          else
+            @missing_headers_optional << attribute.name
+          end
+        else
+          found_at_least_one = true
+        end
+      end
+      if found_at_least_one
+        logger.warning "Missing optional headers: #{@missing_headers_optional.join(',')}".yellow unless @missing_headers_optional.empty?
+        logger.warning "Missing mandatory headers: #{@missing_headers_mandatory.join(',')}".red unless @missing_headers_mandatory.empty?
+      end
+      return false unless @missing_headers_mandatory.empty?
+      true
+    end
+
+    def find_excel_header_row
+      @roo.sheets.each do |sheet|
+        logger.info "Looking for the header row in sheet #{sheet}".cyan
+        @roo.default_sheet = sheet
+        @roo.first_row.upto(@roo.last_row) do |row|
+          headers = {}
+          (@roo.first_column..@roo.last_column).each do |column|
+            converter_attributes.each do |attribute|
+
+              if attribute.matches? @roo.cell(row, column).to_s
+                logger.info "Found header for #{attribute.name.to_s.green} at column #{column} at row #{row}"
+                if (headers[attribute.name].nil?)
+                  headers[attribute.name] = column
+                else
+                  logger.warn "Found duplicate header '#{attribute.name.to_s.red}' on columns #{column} and #{headers[attribute.name]}."
+                end
+              end
+            end
+          end
+
+          if all_headers_found(headers)
+            logger.info "All headers found on row #{row}".green
+            return {:row => row, :sheet => sheet, :headers => headers}
+          end
+        end
+      end
+      return nil
+    end
+  end
+end

data/lib/rseed/roo/version.rb

@@ -0,0 +1,5 @@
+module Rseed
+  module Roo
+    VERSION = "1.0.0"
+  end
+end

data/lib/tasks/rseed-roo.rake

@@ -0,0 +1,18 @@
+require "rseed"
+require "colorize"
+
+namespace :rseed do
+  desc "Seed an Excel file using the RooAdapter and a converter"
+  task :excel => :environment do
+    converter = ENV["converter"] || ENV["CONVERTER"]
+    converter_options = ENV["converter_options"] || ENV["CONVERTER_OPTIONS"]
+    file = ENV["file"] || ENV["FILE"]
+    if file && converter
+      options = {converter: converter}
+      options[:converter_options] = converter_options if converter_options
+      Rseed::from_excel file, options
+    else
+      puts "You must specify file=<file> and converter=<converter>".red
+    end
+  end
+end

data/rseed-roo.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rseed/roo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rseed-roo"
+  spec.version       = Rseed::Roo::VERSION
+  spec.authors       = ["David Monagle"]
+  spec.email         = ["david.monagle@intrica.com.au"]
+  spec.description   = %q{Provides a Roo based adapter for Rseed that allows the import of excel files.}
+  spec.summary       = %q{Roo adapter for Rseed}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rseed"
+  spec.add_dependency "roo"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: rseed-roo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Monagle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rseed
+  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'
+- !ruby/object:Gem::Dependency
+  name: roo
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Provides a Roo based adapter for Rseed that allows the import of excel
+  files.
+email:
+- david.monagle@intrica.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/rseed/roo.rb
+- lib/rseed/roo/helpers.rb
+- lib/rseed/roo/roo_adapter.rb
+- lib/rseed/roo/version.rb
+- lib/tasks/rseed-roo.rake
+- rseed-roo.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.1.9
+signing_key: 
+specification_version: 4
+summary: Roo adapter for Rseed
+test_files: []