smart_importer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5cacfb4ca850a32db12dbd78bce37f1e42af662
+  data.tar.gz: 910e7c20279f423754cc872a5c3f1f951079e431
+SHA512:
+  metadata.gz: 3681792da16c26ebe66ca89fed2b9ccda78910694548cefd870d669f43dca6e74a02f53e6f60d094dc08a20504c14b6a06c7038ef33918295fc02105a4dd55ed
+  data.tar.gz: 13bf729b0ddaee796b9b82c53bd582a55a33eec17c81f1329e57c3ab45544b6eb880617e2d3bf382fbc81395ccfce0319b43e0db0cca8753223df439f4a3a13f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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

@@ -0,0 +1,73 @@
+# SmartImporter
+
+Smart importer allows you to import relevant data from spreadsheets (xlsx or csv) to any of your models with one line of code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_importer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_importer
+
+## Usage
+
+To import data from a spreadsheet to one of your models, first initiate the Importer object. For example:
+
+```ruby
+importer = SmartImporter::Importer.new(file_path: "/path/to/file", model: User, key_attribute: :name)
+```
+
+Where: 
+  :file_path => your file_path
+  :model => the active_record model that you want to fill with relevant data from.
+  :key_attribute => is an optional parameter that you are telling the importer must be unique within all records (Can be useful in some cases although your model validations should normally take care of this.)
+
+and then,
+
+To import all data in sheets from the spreadsheet:
+
+```ruby
+importer.import_all
+```
+or
+
+To import all data in sheets from the nth spreadsheet:
+
+```ruby
+importer.import_sheet(n)
+```
+or
+
+To import all data in sheets from the an array or range array_of_sheets:
+
+```ruby
+importer.import_sheets(array_of_sheets)
+```
+
+Et Voila!! Smart Importer should have found all relevant fields in the spreadsheet and added it to your database.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/smart_importer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smart_importer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smart_importer.rb

@@ -0,0 +1,49 @@
+require "smart_importer/version"
+require "smart_importer/spreadsheet"
+require 'rubygems'
+require "roo"
+require "logger"
+require "active_support/all"
+
+module SmartImporter
+  class Importer
+    def initialize(file_path:, model:, key_attribute: id)
+      @file_path = file_path
+      @model = model
+      @xlsx = Roo::Spreadsheet.open(@file_path.to_s)
+      @number_of_imported_records = 0
+      @key_attribute = key_attribute
+    end
+
+    def import_all
+      import_sheets(1..@xlsx.sheets.count-1)
+    end
+
+    def import_sheet(sheet)
+      import_sheets(Array(sheet))
+    end
+
+    def import_sheets(sheet_array)
+      raise 'Import sheets expects an array of sheet numbers.' unless sheet_array.to_a.all? {|i| i.is_a?(Integer) }
+      logger = Logger.new(STDOUT)
+      logger.info "Importing #{@entity_type.to_s.underscore.pluralize} from #{@file_path}..."
+      begin
+        import_these_sheets sheet_array
+      rescue => exception
+        logger.error "Failed to import #{@entity_type} because #{exception}"
+      else
+        logger.info "Done importing. Imported #{@number_of_imported_records} #{@entity_type.to_s.pluralize}."
+      end
+    end
+
+    private
+
+    def import_these_sheets(sheet_array)
+      @xlsx.sheets.each do |sheet|
+        @xlsx.default_sheet = sheet
+        spreadsheet = Spreadsheet.new(sheet: @xlsx, model: @model, key_attribute: @key_attribute)
+        @number_of_imported_records += spreadsheet.import_objects
+      end
+    end
+  end
+end

data/lib/smart_importer/spreadsheet.rb

@@ -0,0 +1,51 @@
+module SmartImporter
+  class Spreadsheet
+    def initialize(sheet:, model:, key_attribute:)
+      @sheet = sheet
+      @key_attribute = key_attribute
+      @number_imports = 0
+      @looking_at_row = 1
+      @model = model
+    end
+
+    def import_objects(added_attributes: {})
+      ((right_header_row + 1)..@sheet.last_row).each do |i|
+        unless @sheet.row(i).empty?
+          row = Hash[[@sheet.row(right_header_row), @sheet.row(i)].transpose]
+          if active_record = @model.where(name: row['name']).try(:first)
+            active_record.update(valid_attributes(row))
+          else
+            @model.create(valid_attributes(row))
+          end
+        end
+        @number_imports += 1
+      end
+      @number_imports
+    end
+
+    private
+
+    def right_header_row
+      until valid_header_line?
+        @looking_at_row += 1
+        raise "#{@sheet.last_row} sheet does not appear to have any relevant information." if sheet_is_invalid?
+      end
+      @looking_at_row
+    end
+
+    def sheet_is_invalid?
+      @looking_at_row == 10
+    end
+
+    def valid_header_line?
+      @sheet.row(@looking_at_row).any?{|cell| @model.column_names.include?(cell.to_s.underscore.try(:to_sym))}
+    end
+
+    def valid_attributes(row)
+      formatted_row = {}
+      row.each {|key, value| formatted_row[key.downcase.gsub(' ', '_').to_sym] = value if key.present? }
+      attribute_keys = @model.column_names.collect(&:to_sym) & formatted_row.keys
+      formatted_row.with_indifferent_access.slice(*attribute_keys) || {}
+    end
+  end
+end

data/lib/smart_importer/version.rb

@@ -0,0 +1,3 @@
+module SmartImporter
+  VERSION = "0.1.0"
+end

data/smart_importer.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_importer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_importer"
+  spec.version       = SmartImporter::VERSION
+  spec.authors       = ["Daniel Fugere"]
+  spec.email         = ["danielfugere28@gmail.com"]
+
+  spec.summary       = %q{Smart Importer allows you to import relevant data from spreadsheets (xlsx or csv) to any of your models with one line of code.}
+  spec.description   = %q{Smart Importer allows you to import relevant data from spreadsheets (xlsx or csv) to any of your models with one line of code.}
+  spec.homepage      = "https://github.com/dafuga/smart_importer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'roo', '~> 2.3'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: smart_importer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Fugere
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Smart Importer allows you to import relevant data from spreadsheets (xlsx
+  or csv) to any of your models with one line of code.
+email:
+- danielfugere28@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smart_importer.rb
+- lib/smart_importer/spreadsheet.rb
+- lib/smart_importer/version.rb
+- smart_importer.gemspec
+homepage: https://github.com/dafuga/smart_importer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Smart Importer allows you to import relevant data from spreadsheets (xlsx
+  or csv) to any of your models with one line of code.
+test_files: []