active_excel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02a921c8804e0087ad6611aff4b59dd6d4bf65f431498e0f6292592e312e33e3
+  data.tar.gz: 8e0bd5247eaa8fdaf51524e09a41078ce9e6b3e2be504e7ed17b785434297b05
+SHA512:
+  metadata.gz: 97b09f9bd60f37ba0893a2918a5a8c1b562f7196ef0c07da81ab9472c8482aa0c3ecaa19b7a90c03bc318609369b7e3e978dec8449da5c76505e1f2b8db1dab8
+  data.tar.gz: 57330883c5693ffe899193bead9202c5aa40584475f12eb115f387d5f10b6b8f20e6385ffc67841da306445527a1fce7e561fe668af39a54224b00391b1ca5ec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+.DS_Store
+/test/excel_files/*

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at riemann1618@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_excel.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    active_excel (0.1.0)
+      activerecord (~> 5.2.2)
+      rubyXL (~> 3.3.33)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.1.4)
+    i18n (1.5.2)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    rubyXL (3.3.33)
+      nokogiri (>= 1.4.4)
+      rubyzip (>= 1.1.6)
+    rubyzip (1.2.2)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_excel!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  sqlite3 (~> 1.3.13)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 logicoffee
+
+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,95 @@
+# ActiveExcel
+ActiveExcel allows you to build ActiveRecord objects from an Excel file with validations.
+
+Suppose that you have User model and an Excel file of users data. Then you can get an array of User objects according to data in the Excel.
+
+## Installation
+In Gemfile:
+
+```ruby
+gem 'active_excel'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_excel
+
+## Usage
+Let's use this gem to the following User model.
+```ruby
+create_table "user", force: :cascade do |t|
+    t.string "name"
+    t.string "email"
+    t.integer "age"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+end
+```
+
+And validations is defined like this:
+```ruby
+class User < ApplicationRecord
+  EMAIL_REGEX = /valid email regex/i
+
+  validates :name,  presence: true
+  validates :email, presence: true, format: { with: EMAIL_REGEX }
+end
+```
+
+### Setup
+All you have to do is insert a line in the model definition.
+
+```ruby
+class User < ApplicationRecord
+  extend ActiveExcel
+  
+end
+```
+
+Then you can use the following methods:
+
+```ruby
+validated_users = User.build_from_excel("path/to/excel/file")
+validated_users.valid_records #=> an array of valid users
+validated_users.invalid_records #=> an array of invalid users
+validated_users.records #=> an array of all users
+```
+
+### Required Excel format
+
+1. Sheet name should be equal to the table name
+    - ActiveExcel searches by the table name.
+    - There can be another sheet, which will be ignored.
+
+1. The first row should be for the column names
+    - ActiveExcel identifies each attributes from the first row.
+    - There can be other columns for extra purposes.
+
+1. There shouldn't be empty rows.
+    - Even if a row seems empty, it can be actually non-empty.
+
+Here is an example of valid format:
+
+|  |1    |2                |3   |
+|:-|:----|:----------------|:---|
+|1 |name |email            |note|
+|2 |Alice|alice@wonder.land|foo |
+|3 |Bob  |bob@sponge.com   |bar |
+
+It doesn't matter that there is `note` column which User model doesn't have.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/logicoffee/active_excel. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveExcel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/logicoffee/active_excel/blob/master/CODE_OF_CONDUCT.md).

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 => :test

data/active_excel.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_excel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_excel"
+  spec.version       = ActiveExcel::VERSION
+  spec.authors       = ["logicoffee"]
+  spec.email         = ["riemann1618@gmail.com"]
+
+  spec.summary       = %q{Build ActiveRecord objects from an Excel file with vaidations}
+  spec.description   = %q{This is a gem which allows you to build ActiveRecord objects from an Excel file with validations in your rails application.}
+  spec.homepage      = "https://github.com/logicoffee/active_excel"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 5.2.2"
+  spec.add_dependency "rubyXL", "~> 3.3.33"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.13"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_excel"
+
+# 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(__FILE__)

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/active_excel.rb

@@ -0,0 +1,32 @@
+require "active_excel/version"
+require "active_excel/validated_records"
+require "active_record"
+require "rubyXL"
+
+module ActiveExcel
+  def build_from_excel(file_path)
+    workbook = RubyXL::Parser.parse(file_path)
+    table_name = self.name.underscore.pluralize
+
+    sheet = workbook[table_name]
+    column_names = sheet[0].cells.map(&:value)
+
+    captured_attributes = self.attribute_names.map do |attribute|
+      if column_names.include?(attribute)
+        [attribute.to_sym, column_names.index(attribute)]
+      end
+    end.compact.to_h
+
+    records = []
+    sheet[1..-1].each do |row|
+      if row
+        attributes = captured_attributes.map do |attribute, index|
+          [attribute, row[index].value]
+        end.to_h
+        records << self.new(attributes)
+      end
+    end
+
+    ValidatedRecords.new(table_name, records)
+  end
+end

data/lib/active_excel/validated_records.rb

@@ -0,0 +1,22 @@
+require "active_record"
+
+module ActiveExcel
+  class ValidatedRecords
+    def initialize(table_name, records)
+      @table_name = table_name
+      @records    = records
+    end
+
+    def all_records
+      @records
+    end
+
+    def valid_records
+      @records.select(&:valid?)
+    end
+
+    def invalid_records
+      @records.reject(&:valid?)
+    end
+  end
+end

data/lib/active_excel/version.rb

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: active_excel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- logicoffee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.33
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.33
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+description: This is a gem which allows you to build ActiveRecord objects from an
+  Excel file with validations in your rails application.
+email:
+- riemann1618@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_excel.gemspec
+- bin/console
+- bin/setup
+- lib/active_excel.rb
+- lib/active_excel/validated_records.rb
+- lib/active_excel/version.rb
+homepage: https://github.com/logicoffee/active_excel
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Build ActiveRecord objects from an Excel file with vaidations
+test_files: []