heart_seed 0.0.1.beta1 → 0.0.1.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00e700cd31219d035de3f79465a7100761273f02
-  data.tar.gz: ae3bb179f7bd42d1f0529dd495bdc8b96fbbca7a
+  metadata.gz: b6cdf153eeacd0a2bb25e04f0b086d6c3d5b47f5
+  data.tar.gz: d7c2518396273ff9de9771c6985b6f3590fedd97
 SHA512:
-  metadata.gz: 43c0dbba243860dfc16ace5d25f6ea84ed4518bda85bd82365fdf16081f48297c4ecb411897e8414616368e323575ac33c626c6dbc886f6db2e980a943b966af
-  data.tar.gz: 8e1d46e47673368a8840d19aff78de1fd1410a251825c33bec1b64b0fb9ab1a24e3c8ab9d735c977e39539ccd56bbeb73e18a10cd20fef2745652c67d16fe877
+  metadata.gz: 6634e532e3fbef27ceb93dce2d138428df7ed6992fab00f5164b8b8a4918888fa396a7d2998da703533bc2f9613a4ac31f0496c9ae07dfd5322e9c2c666a8e90
+  data.tar.gz: d99648ac07a0816d9c11c9c7e5c9dfda693010b63b6d2a224a7ea90655a63cff751ceeaa65290bf19966712cbce72a7ab5f7f9ada57c7944e3e160bccff96e48

data/README.md

@@ -1,12 +1,15 @@
 # [WIP] HeartSeed
 
-seed util (excel -> yaml -> db) 
+seed util (excel -> yaml -> db)
 
+[![Gem Version](https://badge.fury.io/rb/heart_seed.svg)](http://badge.fury.io/rb/heart_seed)
 [![Build Status](https://travis-ci.org/sue445/heart_seed.svg)](https://travis-ci.org/sue445/heart_seed)
 [![Code Climate](https://codeclimate.com/github/sue445/heart_seed.png)](https://codeclimate.com/github/sue445/heart_seed)
 [![Coverage Status](https://img.shields.io/coveralls/sue445/heart_seed.svg)](https://coveralls.io/r/sue445/heart_seed?branch=master)
 [![Dependency Status](https://gemnasium.com/sue445/heart_seed.svg)](https://gemnasium.com/sue445/heart_seed)
 
+[![Stories in Ready](https://badge.waffle.io/sue445/heart_seed.png?label=ready&title=Ready)](https://waffle.io/sue445/heart_seed)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,13 +30,105 @@ Or install it yourself as:
   * create `config/heart_seed.yml`, `db/xls`, `db/seeds`
   * append to `db/seeds.rb`
 2. Create xls
+  * sheet name (xls,xlsx) = table name (DB)
   * example https://github.com/sue445/heart_seed/tree/master/spec/dummy/db/xls
 3. `bundle exec rake heart_seed:xls`
   * Generate yml to `db/seeds`
-  * If you want to specify files: `FILES=comments_and_likes.xls SHEETS=comments,likes bundle exec rake heart_seed:xls` 
-4. `bundle exec rake db:seed`
+  * If you want to specify files: `FILES=comments_and_likes.xls SHEETS=comments,likes bundle exec rake heart_seed:xls`
+4. `bundle exec rake db:seed` or `bundle exec rake heart_seed:db:seed`
   * Import yml to db
-  * If you want to specify tables: `TABLES=articles,comments bundle exec rake db:seed` 
+  * Exists `TABLES`, `CATALOGS` options
+
+examples
+
+```sh
+TABLES=articles,comments bundle exec rake db:seed
+CATALOGS=article,user bundle exec rake db:seed
+```
+
+### other Rails
+
+append this to `Rakefile`
+
+```ruby
+require 'heart_seed/tasks'
+```
+
+### Snippets
+#### config/heart_seed.yml
+```yml
+seed_dir: db/seeds
+xls_dir: db/xls
+catalogs:
+#  user:
+#  - users
+#  - user_profiles
+```
+
+#### db/seeds.rb
+```ruby
+# Appended by `rake heart_seed:init`
+HeartSeed::DbSeed.import_all
+```
+
+## Specification
+### Supported xls/xlsx format
+
+Example sheet
+
+id  | title	 | description  | created_at     |     | this is dummy
+--- | ------ | ------------ | -------------- | --- | --------------
+1   | title1 | description1 | 2014/6/1 12:10 |     | foo
+2   | title2 | description2 | 2014/6/2 12:10 | 	   | baz
+
+* Sheet name is mapped table name
+  * If sheet name is not found in database, this is ignored
+* 1st row : table column names
+  * If the spaces are included in the middle, right columns are ignored
+* 2nd row ~ : records
+  * [ActiveSupport::TimeWithZone](http://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html) is used for timezone
+
+### Yaml format
+
+example
+
+```yaml
+---
+articles_1:
+  id: 1
+  title: title1
+  description: description1
+  created_at: '2014-06-01 12:10:00 +0900'
+articles_2:
+  id: 2
+  title: title2
+  description: description2
+  created_at: '2014-06-02 12:10:00 +0900'
+```
+
+* same as [ActiveRecord::FixtureSet](http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html) format
+
+### Catalog
+Catalog is table groups defined in heart_seed.yml
+
+example
+
+```yml
+catalogs:
+  user:
+  - users
+  - user_profiles
+```
+
+`user` catalog = `users`, `user_profiles` tables
+
+
+You can specify the catalogs at `db:seed` task
+
+```sh
+CATALOGS=user bundle exec rake db:seed
+# same to) TABLES=users,user_profiles bundle exec rake db:seed
+```
 
 ## Contributing
 

data/lib/heart_seed/converter.rb

@@ -87,7 +87,7 @@ module HeartSeed
     #
     # @return [ Hash{ String => Hash{ String => Object } } ]
     def self.read_sheet(sheet, row_prefix)
-      header_keys = sheet.row(HEADER_ROW)
+      header_keys = select_left_of_blank(sheet.row(HEADER_ROW))
       fixtures = {}
 
       (HEADER_ROW + 1 .. sheet.last_row).each do |row_num|
@@ -95,11 +95,11 @@ module HeartSeed
         header_keys.each_with_index do |key, col_index|
           value = sheet.cell(row_num, col_index + 1)
 
-          case sheet.celltype(row_num, col_index + 1)
-          when :float
+          case value
+          when Float
             # ex) 1.0 -> 1
             value = value.to_i if value == value.to_i
-          when :date, :time, :datetime
+          when DateTime
             # value is DateTime and localtime, but not included TimeZone(UTC)
             time = Time.zone.at(value.to_i - Time.zone.utc_offset)
             value = time.to_s
@@ -116,5 +116,15 @@ module HeartSeed
 
       fixtures
     end
+
+    def self.select_left_of_blank(array)
+      response = []
+      array.each do |element|
+        break unless element
+        break if element.respond_to?(:blank?) && element.blank?
+        response << element
+      end
+      response
+    end
   end
 end

data/lib/heart_seed/db_seed.rb

@@ -21,30 +21,49 @@ module HeartSeed
     #
     # @param seed_dir [String]
     # @param tables   [Array<String>,String] table names array or comma separated table names. if empty, import all seed yaml. if not empty, import only these tables.
-    def self.import_all(seed_dir: HeartSeed::Helper.seed_dir, tables: [])
-      target_tables = parse_arg_tables(tables)
+    def self.import_all(seed_dir: HeartSeed::Helper.seed_dir, tables: ENV["TABLES"], catalogs: ENV["CATALOGS"])
+      # use tables in catalogs
+      target_tables = parse_arg_catalogs(catalogs)
+      if target_tables.empty?
+        # use tables
+        target_tables = parse_string_or_array_arg(tables)
+      end
 
+      ActiveRecord::Migration.verbose = true
       Dir.glob(File.join(seed_dir, "*.yml")) do |file|
         table_name = File.basename(file, '.*')
         next unless target_table?(table_name, target_tables)
 
-        begin
-          model_class = table_name.classify.constantize
-          bulk_insert(source_file: file, model_class: model_class)
-          puts "[INFO] #{file} -> #{table_name}"
-        rescue => e
-          puts "[ERROR] #{e.message}"
+        ActiveRecord::Migration.say_with_time("#{file} -> #{table_name}") do
+          begin
+            model_class = table_name.classify.constantize
+            bulk_insert(source_file: file, model_class: model_class)
+            ActiveRecord::Migration.say("[INFO] success", true)
+          rescue => e
+            ActiveRecord::Migration.say("[ERROR] #{e.message}", true)
+          end
         end
       end
     end
 
-    def self.parse_arg_tables(tables)
+    def self.parse_string_or_array_arg(tables)
       return [] unless tables
       return tables if tables.class == Array
 
       tables.class == String ? tables.split(",") : []
     end
 
+    def self.parse_arg_catalogs(catalogs)
+      array_catalogs = parse_string_or_array_arg(catalogs)
+      return [] if array_catalogs.empty?
+
+      tables = []
+      array_catalogs.each do |catalog|
+        tables += HeartSeed::Helper.catalog_tables(catalog)
+      end
+      tables.compact
+    end
+
     private
     def self.target_table?(source_table, target_tables)
       return true if target_tables.empty?

data/lib/heart_seed/helper.rb

@@ -11,6 +11,7 @@ module HeartSeed
         {
             "seed_dir" => "db/seeds",
             "xls_dir"  => "db/xls",
+            "catalogs" => {},
         }
       end
     end
@@ -45,5 +46,16 @@ module HeartSeed
     def self.root_dir=(dir)
       @root_dir = Pathname.new(dir)
     end
+
+    # @return [Hash{String => Array<String>}] key: catalog name, value: table names
+    def self.catalogs
+      config["catalogs"] || {}
+    end
+
+    # @param catalog_name [String]
+    # @return [Array<String>] table names in a specify catalog
+    def self.catalog_tables(catalog_name)
+      self.catalogs[catalog_name] || []
+    end
   end
 end

data/lib/heart_seed/railtie.rb

@@ -1,7 +1,7 @@
 module HeartSeed
   class Railtie < ::Rails::Railtie
     rake_tasks do
-      load "heart_seed/tasks/heart_seed.rake"
+      require "heart_seed/tasks"
     end
   end
 end

data/lib/heart_seed/tasks.rb

@@ -0,0 +1 @@
+load "heart_seed/tasks/heart_seed.rake"

data/lib/heart_seed/tasks/heart_seed.rake

@@ -1,10 +1,10 @@
 namespace :heart_seed do
   desc "create dir and file"
-  task :init => ["config/heart_seed.yml", "db/xls", "db/seeds"] do
+  task :init => ["config/heart_seed.yml", "db/xls/.gitkeep", "db/seeds/.gitkeep"] do
     template = <<RUBY
 
 # Appended by `rake heart_seed:init`
-HeartSeed::DbSeed.import_all(tables: ENV["TABLES"])
+HeartSeed::DbSeed.import_all
 
 RUBY
 
@@ -15,43 +15,64 @@ RUBY
     template = <<YAML
 seed_dir: db/seeds
 xls_dir: db/xls
+catalogs:
+#  user:
+#  - users
+#  - user_profiles
 YAML
 
     create_file("config/heart_seed.yml", template)
   end
 
+  file "db/xls/.gitkeep" => "db/xls" do
+    create_file("db/xls/.gitkeep")
+  end
+
+  file "db/seeds/.gitkeep" => "db/seeds" do
+    create_file("db/seeds/.gitkeep")
+  end
+
   directory "config"
   directory "db/xls"
   directory "db/seeds"
 
-  desc "create seed files by xls directory"
+  desc "create seed files by xls directory (options: FILES=table1.xls,table2.xlsx SHEETS=sheet1,sheet2)"
   task :xls => :environment do
+    ActiveRecord::Migration.verbose = true
     Dir.glob(File.join(HeartSeed::Helper.xls_dir, "*.{xls,xlsx}")) do |file|
       next if File.basename(file) =~ /^~/
 
       next unless target_file?(file)
 
-      puts "Source File: #{file}"
-      sheets = HeartSeed::Converter.table_sheets(file)
-      sheets.each do |sheet|
-        unless ActiveRecord::Base.connection.table_exists?(sheet)
-          puts "  [#{sheet}] Table is not found"
-          next
-        end
-
-        next unless target_sheet?(sheet)
-
-        dist_file = File.join(HeartSeed::Helper.seed_dir, "#{sheet}.yml")
-        fixtures = HeartSeed::Converter.convert_to_yml(source_file: file, source_sheet: sheet, dist_file: dist_file)
-        if fixtures
-          puts "  [#{sheet}] Create seed: #{dist_file}"
-        else
-          puts "  [#{sheet}] Sheet is empty"
+      ActiveRecord::Migration.say_with_time("Source File: #{file}") do
+        sheets = HeartSeed::Converter.table_sheets(file)
+        sheets.each do |sheet|
+          unless ActiveRecord::Base.connection.table_exists?(sheet)
+            ActiveRecord::Migration.say("[#{sheet}] Table is not found", true)
+            next
+          end
+
+          next unless target_sheet?(sheet)
+
+          dist_file = File.join(HeartSeed::Helper.seed_dir, "#{sheet}.yml")
+          fixtures = HeartSeed::Converter.convert_to_yml(source_file: file, source_sheet: sheet, dist_file: dist_file)
+          if fixtures
+            ActiveRecord::Migration.say("[#{sheet}] Create seed: #{dist_file}", true)
+          else
+            ActiveRecord::Migration.say("  [#{sheet}] Sheet is empty", true)
+          end
         end
       end
     end
   end
 
+  namespace :db do
+    desc "Load the seed data from db/seeds/*.yml (options: TABLES=table1,table2 CATALOGS=catalog1,catalog2)"
+    task :seed => :environment do
+      HeartSeed::DbSeed.import_all
+    end
+  end
+
   private
   def target_file?(file)
     return true if ENV["FILES"].blank?
@@ -65,9 +86,9 @@ YAML
     ENV["SHEETS"].split(",").include?(sheet)
   end
 
-  def create_file(file, str)
+  def create_file(file, str = nil)
     open(file, "w") do |out|
-      out.write(str)
+      out.write(str) if str
     end
 
     puts "create: #{file}"

data/lib/heart_seed/version.rb

@@ -1,3 +1,3 @@
 module HeartSeed
-  VERSION = "0.0.1.beta1"
+  VERSION = "0.0.1.beta2"
 end

data/spec/heart_seed/converter_spec.rb

@@ -56,4 +56,20 @@ YAML
 
     it{ should == ["articles", "Sheet2"] }
   end
+
+  describe "#select_left_of_blank" do
+    subject{ HeartSeed::Converter.select_left_of_blank(array) }
+
+    context "When not include blank cell" do
+      let(:array){ ["id", "name"] }
+
+      it{ should eq ["id", "name"] }
+    end
+
+    context "When include blank cell" do
+      let(:array){ ["id", "name", "", "this is not table column"] }
+
+      it{ should eq ["id", "name"] }
+    end
+  end
 end

data/spec/heart_seed/db_seed_spec.rb

@@ -9,9 +9,16 @@ describe HeartSeed::DbSeed do
   end
 
   describe "#import_all" do
-    subject{ HeartSeed::DbSeed.import_all(seed_dir: seed_dir, tables: tables)  }
+    subject{ HeartSeed::DbSeed.import_all(seed_dir: seed_dir, tables: tables, catalogs: catalogs)  }
 
     let(:seed_dir){ FIXTURE_DIR }
+    let(:tables)  { [] }
+    let(:catalogs){ [] }
+
+    before do
+      # FIXME can not clear if using `DatabaseRewinder.clean`
+      DatabaseRewinder.clean_all
+    end
 
     after do
       # FIXME can not clear if using `DatabaseRewinder.clean`
@@ -19,8 +26,6 @@ describe HeartSeed::DbSeed do
     end
 
     context "When empty tables" do
-      let(:tables)  { [] }
-
       it{ expect{ subject }.to change(Article, :count).by(2) }
       it{ expect{ subject }.to change(Comment, :count).by(2) }
       it{ expect{ subject }.to change(Like   , :count).by(1) }
@@ -33,10 +38,24 @@ describe HeartSeed::DbSeed do
       it{ expect{ subject }.to change(Comment, :count).by(0) }
       it{ expect{ subject }.to change(Like   , :count).by(0) }
     end
+
+    context "When specify catalogs" do
+      let(:catalogs){ ["article"] }
+
+      before do
+        allow(HeartSeed::Helper).to receive(:catalogs){
+          { "article" => ["articles", "likes"] }
+        }
+      end
+
+      it{ expect{ subject }.to change(Article, :count).by(2) }
+      it{ expect{ subject }.to change(Comment, :count).by(0) }
+      it{ expect{ subject }.to change(Like   , :count).by(1) }
+    end
   end
 
-  describe "#parse_arg_tables" do
-    subject{ HeartSeed::DbSeed.parse_arg_tables(tables) }
+  describe "#parse_string_or_array_arg" do
+    subject{ HeartSeed::DbSeed.parse_string_or_array_arg(tables) }
 
     where(:tables, :expected) do
       [
@@ -51,4 +70,32 @@ describe HeartSeed::DbSeed do
       it{ should eq expected }
     end
   end
+
+  describe "#parse_arg_catalogs" do
+    subject{ HeartSeed::DbSeed.parse_arg_catalogs(catalogs) }
+
+    before do
+      allow(HeartSeed::Helper).to receive(:catalogs){
+        {
+            "article" => ["articles", "likes"],
+            "user"    => ["users", "user_profiles"],
+        }
+      }
+    end
+
+    where(:catalogs, :expected) do
+      [
+          [nil              , []],
+          [""               , []],
+          ["article"        , %w(articles likes)],
+          ["article,user"   , %w(articles likes users user_profiles)],
+          [%w(article)      , %w(articles likes)],
+          [%w(article user) , %w(articles likes users user_profiles)],
+      ]
+    end
+
+    with_them do
+      it{ should eq expected }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heart_seed
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta1
+  version: 0.0.1.beta2
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -298,6 +298,7 @@ files:
 - lib/heart_seed/db_seed.rb
 - lib/heart_seed/helper.rb
 - lib/heart_seed/railtie.rb
+- lib/heart_seed/tasks.rb
 - lib/heart_seed/tasks/heart_seed.rake
 - lib/heart_seed/version.rb
 - spec/data/articles.xls