activerecord_data_importer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ebdc71d64176a86427eb21488dc8a88f11f203a
+  data.tar.gz: c9529d154b5556a4cfbca919bc77df28f838bd49
+SHA512:
+  metadata.gz: 5304fa3f990f2989e208446494478e924ac64514d69450c0394c718e41fa63ae3f2e986a2135ac160923c1671fa0dbad90b58d9dc299c540f2c9629959a81c95
+  data.tar.gz: e01776c4641c4b835ecdd8dbbce57a61715264a9417f4004a8cdaea5cd8981aab4bf99031ac863aba01575b95dfaade46be423750579f98798e699e648289fd1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+nguage: ruby
+rvm:
+  - 2.2.0
+  - 2.2.1
+install: bundle install
+cache:
+  directories:
+  - vendor/bundle
+script: bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord_json_loader.gemspec
+gemspec
+gem 'mysql2', '~> 0.3.18'
+gem 'activerecord', '~> 4.2.0'
+gem 'activesupport', '~> 4.2.0'
+gem 'rspec'
+gem 'database_rewinder'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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,202 @@
+# ActiverecordDataImporter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activerecord_data_importer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_data_importer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord_data_importer
+
+## Usage
+
+### Basic
+please include sentence on ActiveRecord's Model
+```
+  include ActiverecordDataImporter
+
+```
+
+When you defined model like this
+```
+class Item < ActiveRecord::Base
+  include ActiverecordDataImporter
+end 
+
+schema
+///////////
+  create_table "Items", force: :cascade do |t|
+    t.string "name", null: false
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
+  end
+///////////
+```
+
+and exsit file json file like context,
+```
+[
+  { "id": 1, "name": "hoge" },
+  { "id": 2, "name": "huga" }
+]
+```
+
+you'll be able to import the following description(json file path is /foo/bar/items.json).
+```
+Item.import_from_json "/foo/bar/items.json"
+```
+
+If json single object following description, it can be used in the same way.
+```
+{ "id": 1, "name": "hoge" }
+```
+
+### Association support
+If you've used association model
+example
+```
+
+class Item < ActiveRecord::Base
+  include ActiverecordDataImporter
+  has_many :item_effects
+end 
+
+class ItemEffect < ActiveRecord::Base
+  include ActiverecordDataImporter
+end 
+
+schema
+///////////
+  create_table "Items", force: :cascade do |t|
+    t.string "name", null: false
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
+  end
+
+  create_table "Item_effects", force: :cascade do |t|
+    t.integer "value", null: false
+    t.integer "item_id", null: false
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
+  end
+///////////
+```
+you can import such json structure
+```
+[
+  {
+    "id": 1,
+    "name": "hoge",
+    "item_effects":[
+      { "value": 1 },
+      { "value": 2 },
+      { "value": 3 }
+    ]
+  },
+  {
+    "id": 2,
+    "name": "huga",
+    "item_effects":[
+      { "value": 1 },
+      { "value": 2 },
+      { "value": 3 }
+    ]
+  },
+  {
+    "id": 3,
+    "name": "piyo",
+    "item_effects":[
+      { "value": 1 },
+      { "value": 2 },
+      { "value": 3 }
+    ]
+  }
+]
+```
+You can also import in the same way if it multistage association in the correct json description.
+
+### Versioning number
+If importing target schema has version column, It will be increment automatically each time a record is updated.
+But, if same data importing (no change), version is not updated.
+Also, having assosiation and updating child association, parent version is updated.
+Furthermore, when version is updated, version number is that obtained by adding 1 to the highest number in all data before the update
+
+### csv supporting
+csv file format is supported. if you want to use relational structure, please define same row and column name should be dotted
+And if relational data is `has_many` structure, please put the serial number before the dot
+ex:
+csv file
+```
+id,name,item_effects1.value,item_effects2.value,item_effects3.value
+1,hoge,1,2,3
+2,huga,1,2,3
+3,piyo,1,2,3
+```
+table showing
+| id        | name           | item_effects1.value  | item_effects2.value | item_effects3.value |
+| ------------- | ------------- | ------------- | ------------- | ------------- | 
+| 1      | hoge  | 1 | 2 | 3 |
+| 2      | huga  | 1 | 2 | 3 |
+| 3      | piyo  | 1 | 2 | 3 |
+
+## Note that
+
+* If id does not exist json's attributes, new record will be created. As long as it does not want this thing , always please do put the id.
+* Case of has_many association existed, always sync import data. Example for previous model structure (item and item_effect), if the effect associated with the item Two importing the data associated with three one state , and is adjusted to two.
+```
+when before imported data is
+  {
+    "id": 1,
+    "name": "hoge",
+    "item_effects":[
+      { "value": 1 },
+      { "value": 2 },
+      { "value": 3 }
+    ]
+  }
+and after is...
+  {
+    "id": 1,
+    "name": "hoge",
+    "item_effects":[
+      { "value": 1 },
+      { "value": 2 }
+    ]
+  }
+
+the result is that..
+Item.find(1).item_effects
+>> [#<ItemEffect id: 1, item_id: 1, value: 1, created_at: "2015-09-15 09:32:19", updated_at: "2015-09-15 09:32:19">, #<ItemEffect id: 2, item_id: 1, value: 2, created_at: "2015-09-15 09:32:19", updated_at: "2015-09-15 09:32:19">] 
+```
+* belong_to assosiasion is not supported
+* default versioning is maybe undesirable for you. The reason is that is processing to get the latest version is published full scan query.
+ * If you think you undesirable this, this method should be overridden to get the latest version in a different way.
+ * ex)
+ * using cache store latest version.
+ * using model for version information.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/activerecord_data_importer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/activerecord_data_importer.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord_data_importer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord_data_importer"
+  spec.version       = ActiverecordDataImporter::VERSION
+  spec.authors       = ["ukayare"]
+  spec.email         = ["ukayare@gmail.com"]
+
+  spec.summary       = %q{Data in file (csv or json) load to ActiveRecord schema mapping object extension}
+  spec.description   = %q{ActiverecordDataImporter is enable to load and import file (format is csv, json) for ActiveRecord's model. For example, when you must use and import master data(ex. game character, enemy, and item stc), it will help you. }
+  spec.homepage      = "https://github.com/ukayare/activerecord_data_importer"
+
+  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"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord_data_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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord_data_importer.rb

@@ -0,0 +1,140 @@
+require "active_support/concern"
+require "activerecord_data_importer/version"
+require "activerecord_data_importer/csv_converter"
+
+module ActiverecordDataImporter
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def import_from_csv(filename)
+      csv_data = ActiverecordDataImporter::CsvConverter.convert_csv_to_hash(filename)
+      self.import_data csv_data
+    end
+
+    def import_from_json(filename)
+      json_data = self.load_json filename
+      self.import_data json_data
+    end
+
+    def divide_attributes(row_data)
+      row_data.partition { |k, _v| self.attribute_names.include? k }.map(&:to_h)
+    end
+
+    def divide_relation_key(another_attributes)
+      relation_keys = self.reflect_on_all_associations.map(&:name).map(&:to_s)
+      another_attributes.select { |key, value| relation_keys.include? key }
+    end
+
+    def get_latest_version
+      # note
+      # This method is published full scan query.
+      # If you think you undesirable this, this method should be overridden to get the latest version in a different way.
+      # ex)
+      # * using cache store latest version.
+      # * using model for version information.
+      if self.attribute_names.include? "version"
+        self.maximum("version").to_i
+      else
+        0
+      end
+    end
+
+    protected
+    def load_json(filename)
+      json_data = open(filename) { |io| JSON.load io }
+    end
+
+    def import_data(json_data)
+      latest_version = self.get_latest_version
+      case json_data
+      when Array
+        json_data.select do |row_data|
+          self.import_row_data row_data, latest_version
+        end.present?
+      when Hash
+        self.import_row_data json_data, latest_version
+      else
+        false
+      end
+    end
+
+    def import_row_data(row_data, latest_version)
+      record_instance = if row_data["id"]
+                          self.where(id: row_data["id"]).first_or_initialize
+                        else
+                          self.new
+                        end
+      record_instance.update_row_data row_data, latest_version
+    end
+  end
+
+  def update_row_data(row_data, latest_version)
+    origin_updated = false
+    relation_updated = false
+    self_attributes, another_attributes = self.class.divide_attributes row_data
+    origin_updated = self.update_origin self_attributes, latest_version
+    return origin_updated if another_attributes.blank?
+    relation_updated = self.update_relation another_attributes
+    if (!origin_updated && relation_updated)
+      self.update_with_version latest_version
+      true
+    else
+      false
+    end
+  end
+
+  def update_origin(self_attributes, latest_version)
+    self_attributes
+    self.attributes = self_attributes
+    return false unless self.changed?
+    self.update_with_version latest_version
+    true
+  end
+
+  def update_relation(another_attributes)
+    latest_version = self.class.get_latest_version
+    self.class.divide_relation_key(another_attributes).select do |key, value|
+    case value
+    when Hash
+      relation_instance = self.try(key) || self.try("build_#{key}")
+      relation_instance.update_row_data value, latest_version
+    when Array
+      relation_instances = self.try(key).to_a
+        updated_flag = false
+        value.each_with_index do |relation_attributes, i|
+          relation_instance = relation_instances[i] || self.try(key).build
+          relation_updated = relation_instance.update_row_data relation_attributes, latest_version
+          updated_flag ||= relation_updated
+        end
+        relation_deleted = self.delete_remain_relation(relation_instances[value.size..-1])
+        updated_flag || relation_deleted
+      else
+        false
+      end
+    end.present?
+  end
+
+
+  def update_with_version(latest_version)
+    if self.respond_to?(:version)
+      self.version = latest_version + 1
+    end
+    if self.class.respond_to? :with_writable
+      self.class.with_writable { self.save }
+    else
+      self.save
+    end
+  end
+
+  def delete_remain_relation(remain_instances)
+    return false if remain_instances.blank?
+    remain_instances.each do |remain_instance|
+      if self.class.respond_to? :with_writable
+        remain_instance.class.with_writable { remain_instance.destroy }
+      else
+        remain_instance.destroy
+      end
+    end
+    true
+  end
+end

data/lib/activerecord_data_importer/csv_converter.rb

@@ -0,0 +1,39 @@
+require "csv"
+class ActiverecordDataImporter::CsvConverter
+  def self.convert_csv_to_hash(filename)
+    csvs = CSV.table(filename, header_converters: :downcase)
+    hash = csvs.map do |csv|
+      self.convert_attributes csv.to_h
+    end
+    hash
+  end
+
+  private
+
+  def self.convert_attributes(csv)
+    returned_csv = csv.to_h.dup
+    csv.to_h.select { |k, _v| k.include? "." }.group_by { |k, _v| k.split(".").first }.each do |k, v|
+      relation_key = k.gsub(/[0-9]+/, "")
+      attributes = v.map { |key, value|[key.gsub(/#{k}\./, ""), value] }.to_h
+      relation_attributes = attributes.select { |key, _v| key.include? "." }
+      if relation_attributes.present?
+        attributes.merge!(self.convert_attributes relation_attributes)
+        relation_attributes.each do |key, _value|
+          attributes.delete key
+          returned_csv.delete "#{k}.#{key}"
+        end
+      end
+      if relation_key == k
+        returned_csv.merge! relation_key => attributes
+      else
+        if returned_csv.key? relation_key
+          returned_csv[relation_key] << attributes
+        else
+          returned_csv[relation_key] = [attributes]
+        end
+      end
+      attributes.each { |key, value| returned_csv.delete "#{k}.#{key}" }
+    end
+    returned_csv
+  end
+end

data/lib/activerecord_data_importer/version.rb

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

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_data_importer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ukayare
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-29 00:00:00.000000000 Z
+dependencies: []
+description: 'ActiverecordDataImporter is enable to load and import file (format is
+  csv, json) for ActiveRecord''s model. For example, when you must use and import
+  master data(ex. game character, enemy, and item stc), it will help you. '
+email:
+- ukayare@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord_data_importer.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord_data_importer.rb
+- lib/activerecord_data_importer/csv_converter.rb
+- lib/activerecord_data_importer/version.rb
+homepage: https://github.com/ukayare/activerecord_data_importer
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Data in file (csv or json) load to ActiveRecord schema mapping object extension
+test_files: []