kandata 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b979ce1bd69f4da1bfa67689cd8e67f1b4e94c2e
-  data.tar.gz: c576026f129471fa86ae2d13989c942521642200
+  metadata.gz: 81234a446c42f891691c7c5d8130512c0a7eaa2b
+  data.tar.gz: 03e57575d6a39b3f056f433fad9cb791ab21dafa
 SHA512:
-  metadata.gz: a2cf47b93f63b3ffa4458e4cafe68dc17d0241319eb4a02b6bb58acb1243af234e2eae3ea9c5c5f678cd500105e4d0944febba4c1764b4a96a0cad94ecd9110e
-  data.tar.gz: 7f166fe8acf20a63bcd46cfaa7e9bdef54ec33adf23396a44076827a689e3f3bc3e4292c5c1fae214f1afa7c2f34c9eca904162502f1e78dab7847ace56c2864
+  metadata.gz: 87912e4ff0f911b3da0e8292877615cf5f8e1ad179d02f22f49ceb3e1eddde9b90965b37440a991aefa6131e94996888c6a6f278a918c79b88043537c82bb3ad
+  data.tar.gz: 776f38b3353eab850e80c3af4d887d51947ad69f3329f72f8f8dfb9d225d47534c49229c73d48251e68b4169fb4f608850b571da60f6f129cbb5cf7f8d79ed07

data/.rubocop.yml

@@ -15,6 +15,10 @@ Bundler/OrderedGems:
   Exclude:
     - 'Gemfile'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
 Metrics/LineLength:
   Max: 130
 

data/README.md

@@ -1,37 +1,46 @@
 # Kandata
 
 [![CircleCI](https://circleci.com/gh/tamano/kandata.svg?style=svg)](https://circleci.com/gh/tamano/kandata)
+[![Gem Version](https://badge.fury.io/rb/kandata.svg)](https://badge.fury.io/rb/kandata)
 
-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/kandata`. To experiment with that code, run `bin/console` for an interactive prompt.
+Kandataは、TSVファイルを自分のローカルのMySQLデータベース内に簡単にロードするためのツールです。
+現在はコマンドラインツールとしてのみ動作します。
 
-TODO: Delete this and the text above, and describe your gem
+## インストール方法
 
-## Installation
+以下のコマンドでインストールしてください。
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'kandata'
-```
-
-And then execute:
+    $ gem install kandata
 
-    $ bundle
+MySQLサーバーがローカルで動作している必要があります。
 
-Or install it yourself as:
+## 利用方法
 
-    $ gem install kandata
+以下のように実行します。
 
-## Usage
+	$ kandata load_tsv TSVファイル名 [--force]
+	
+実行すると、ローカルのMySQLの中に`kandata.TSVファイル名`というテーブルが作成され、TSVの内容がロードされます。
+後は煮るなり焼くなり、自由に使ってください。
 
-TODO: Write usage instructions here
+なお、TSVファイル内で最初のカラムが`id`という名前だった場合、そのカラムがPKとして扱われます。
+最初のカラムが`id`ではなかった場合、テーブルには自動的に`id`というAUTO_INCREMENTなカラムが追加されます。
+先頭以外に`id`という名前のカラムがあった場合はエラーとなります。
 
-## Development
+`--force`オプションを指定すると、実行時に同名のテーブルがあった場合は一度削除して作り直します。
+指定していない場合は、エラーとなります。
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## 制限事項
+- ローカルでMySQLサーバーが動いていて`root`ユーザーがパスワードなしでログイン可能な前提となっています。
+- MySQL以外のRDBMSには現時点では対応していません。
+- `id`を除く各カラムは`VARCHAR(128)`として作られます。他の型を選ぶことは出来ません。
+- 各カラムへのINDEXの追加には対応していません。必要な場合は自分でSQLで`CREATE INDEX`してください。
 
-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).
+## 今後の予定
+- 作成したテーブルに応じたActiveRecordモデルを自動生成できるようにする。
+    - `require`で非RailsなRubyスクリプトで読み込んで使えるように。
+- 作成したテーブルのバックアップなどの機能を追加する。
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kandata.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tamano/kandata.

data/circle.yml

@@ -1,3 +1,7 @@
 machine:
   timezone:
     Asia/Tokyo
+
+database:
+  override:
+    - echo "Skipping DB section."

data/exe/kandata

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'kandata.rb'
 
 Kandata::CLI.start

data/kandata.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '>= 0.52'
   spec.add_development_dependency 'simplecov'
 
+  spec.add_dependency 'activerecord'
   spec.add_dependency 'mysql2'
   spec.add_dependency 'thor'
 end

data/lib/kandata.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+require 'kandata/active_record'
 require 'kandata/database'
+require 'kandata/database/connection_info'
 require 'kandata/tsv_file'
 require 'kandata/version'
 require 'kandata/cli'
@@ -7,9 +9,10 @@ require 'kandata/cli'
 class Kandata
   # load_tsvの後に、ActiveRecordのインスタンスを返す
   def self.build_from_tsv(filename, force_load)
-    _table_name = load_tsv(filename, force_load)
+    full_table_name = load_tsv(filename, force_load)
 
-    # TODO: ActiveRecordインスタンスの作成
+    Kandata::ActiveRecord.connect
+    Kandata::ActiveRecord.create_model(full_table_name.split('.').last)
   end
 
   # テーブルを作成し、テーブルにデータを読み込み、テーブル名を戻す

data/lib/kandata/active_record.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'active_record'
+
+class Kandata
+  class ActiveRecord < ActiveRecord::Base
+    def self.connect
+      establish_connection(
+        adapter:  'mysql2',
+        host:     Kandata::Database::ConnectionInfo.host,
+        username: Kandata::Database::ConnectionInfo.user_name,
+        database: Kandata::Database::ConnectionInfo.database_name
+      )
+    end
+
+    def self.create_model(table_name)
+      Class.new(Kandata::ActiveRecord) do
+        self.table_name = table_name
+      end
+    end
+  end
+end

data/lib/kandata/database.rb

@@ -6,24 +6,31 @@ class Kandata
   class Database < Mysql2::Client
     def initialize
       create_database_if_not_exists
-      super(host: 'localhost', username: 'root', database: database_name, local_infile: true)
+      super(
+        Kandata::Database::ConnectionInfo.host_and_user.merge(
+          database: Kandata::Database::ConnectionInfo.database_name,
+          local_infile: true
+        )
+      )
     end
 
     # ignore :reek:ControlParameter:
     def load_tsv(filename, force_update)
-      tsv = Kandata::TsvFile.new(filename)
+      @tsv = Kandata::TsvFile.new(filename)
 
-      drop_table(tsv) if force_update
-      create_table(tsv)
+      drop_table if force_update
+      create_table
+      load_data
 
-      load_data(tsv)
+      full_table_name
     end
 
     private
 
     # ignore :reek:FeatureEnvy:
     def create_database_if_not_exists
-      client = Mysql2::Client.new(host: 'localhost', username: 'root')
+      client = Mysql2::Client.new(Kandata::Database::ConnectionInfo.host_and_user)
+      database_name = Kandata::Database::ConnectionInfo.database_name
 
       begin
         client.query("SHOW CREATE DATABASE #{database_name}")
@@ -33,13 +40,12 @@ class Kandata
       end
     end
 
-    def drop_table(tsv)
-      query("DROP TABLE IF EXISTS #{full_table_name(tsv)}")
+    def drop_table
+      query("DROP TABLE IF EXISTS #{full_table_name}")
     end
 
-    # ignore :reek:FeatureEnvy:
-    def create_table(tsv)
-      columns = tsv.headers
+    def create_table
+      columns = @tsv.headers
 
       # 後で追加するため一旦削除
       columns.delete('id')
@@ -47,24 +53,18 @@ class Kandata
       columns_text = columns.map { |column| "#{column} VARCHAR(128)" }.join(',')
       columns_text = 'id INTEGER AUTO_INCREMENT NOT NULL PRIMARY KEY,' + columns_text
 
-      query("CREATE TABLE #{full_table_name(tsv)} (#{columns_text})")
+      query("CREATE TABLE #{full_table_name} (#{columns_text})")
     end
 
-    # ignore :reek:FeatureEnvy:
-    def load_data(tsv)
-      sql = "LOAD DATA LOCAL INFILE '#{tsv.filename}' INTO TABLE #{full_table_name(tsv)} IGNORE 1 LINES "
-      sql += "(#{tsv.headers.join(',')})"
+    def load_data
+      sql = "LOAD DATA LOCAL INFILE '#{@tsv.filename}' INTO TABLE #{full_table_name} IGNORE 1 LINES "
+      sql += "(#{@tsv.headers.join(',')})"
 
       query(sql)
-      full_table_name(tsv)
-    end
-
-    def database_name
-      'kandata'
     end
 
-    def full_table_name(tsv)
-      "#{database_name}.#{tsv.table_name}"
+    def full_table_name
+      "#{Kandata::Database::ConnectionInfo.database_name}.#{@tsv.table_name}"
     end
   end
 end

data/lib/kandata/database/connection_info.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Kandata
+  class Database
+    class ConnectionInfo
+      class << self
+        attr_reader :host, :user_name, :database_name
+      end
+
+      @host = 'localhost'
+      @user_name = 'root'
+      @database_name = 'kandata'
+
+      def self.host_and_user
+        { host: @host, username: @user_name }
+      end
+    end
+  end
+end

data/lib/kandata/tsv_file.rb

@@ -6,12 +6,17 @@ class Kandata
 
     def initialize(filename)
       @filename = filename
-      raise 'テーブル名に使用できないファイル名です' unless table_name.match?(/^[0-9a-zA-Z$_]+$/)
+      validate_filename
 
       @headers = File.open(@filename, 'r').first(&:readline).chomp.split("\t")
       validate_headers
     end
 
+    def validate_filename
+      raise 'テーブル名に使用できないファイル名です' unless table_name.match?(/^[0-9a-zA-Z$_]+$/)
+      true
+    end
+
     def validate_headers
       duplicated_columns = @headers.group_by { |value| value }.reject { |_key, value| value.one? }.keys
       raise "以下のカラムが複数存在しています #{duplicated_columns}" unless duplicated_columns.empty?
@@ -21,6 +26,8 @@ class Kandata
 
       # 現時点では、ミス防止のため、先頭以外にidカラムがあるとエラーとして処理する
       raise '先頭以外にidカラムがあります' if include_id_column? && @headers[0] != 'id'
+
+      true
     end
 
     def table_name

data/lib/kandata/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class Kandata
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kandata
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuya TAMANO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-30 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -145,8 +159,10 @@ files:
 - exe/kandata
 - kandata.gemspec
 - lib/kandata.rb
+- lib/kandata/active_record.rb
 - lib/kandata/cli.rb
 - lib/kandata/database.rb
+- lib/kandata/database/connection_info.rb
 - lib/kandata/tsv_file.rb
 - lib/kandata/version.rb
 homepage: https://github.com/tamano/kandata