depend_lister 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b837e8b1568b3735dda47dd12cedd738279eb87a5ef90ffb0aacaf93735a44
-  data.tar.gz: 54d092e6f18a2555368458eed0eaf58064133724706842eea0704474706dee12
+  metadata.gz: 748b8e0c6661dba50f1ff1dca1302bc40f4cde0ff0169b16f0f9f349a30a1743
+  data.tar.gz: bd424a38f6cce4d542795b048604152a9ae12ca00026dfab0d43aad8247b6419
 SHA512:
-  metadata.gz: e62e7dc7bc259b27844431c0485e409126e1c6b822a8e5f38fea0c341e3655b6b6819067704d3c4d192840bba691a7a8d85c329c548e855978b945c934324863
-  data.tar.gz: caf9eb8418d5235ad4f3eb431968e65655d6fa5c8e636c21af1e7298ab529d258f086f2c2affc37008b31480555010cbc262a9dfa77a246d1d40912b93799919
+  metadata.gz: 68e795e7ba69f213e980e8b5ca9a0de7a223584612cd972187897d4cfdad0b4787b18c135c55c5c99fdd5a2872d7b7522168dbbfed12a369ed010d066c7ba450
+  data.tar.gz: 8375045722cb62eb85a0f805b5449c63e53d2892f647ca0519ed5ca67c0070a78f003dbb9885114bb69e230f9d50307dc47667e6a5e1fbe7ef7f3b222f9584a6

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/Gemfile

@@ -3,5 +3,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in depend_lister.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem "rake", "~> 12.3.3"
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug"
+end
+
+group  :test do
+  gem "rspec", "~> 3.0"
+end

data/Gemfile.lock

@@ -6,7 +6,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (11.1.1)
+    coderay (1.1.2)
     diff-lcs (1.3)
+    method_source (1.0.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -28,8 +37,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.1)
   depend_lister!
-  rake (~> 12.0)
+  pry
+  pry-byebug
+  rake (~> 12.3.3)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.0
+   2.1.4

data/README.md

@@ -1,39 +1,65 @@
 # DependLister
 
-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/depend_lister`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+DependLister analyzes belongs_to defined by a model and outputs a list of tables in order with a little dependence.
+When You begin the maintenance of the existing project, it may be helpful.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To use it, add it to your Gemfile:
 
 ```ruby
 gem 'depend_lister'
 ```
 
-And then execute:
+and bundle:
+
+```shell
+bundle
+```
 
-    $ bundle install
+#### Post Installation
 
-Or install it yourself as:
+Install migrations:
 
-    $ gem install depend_lister
+```shell
+rake db:migrate
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```shell
+rails depend_lister
+```
 
-## Development
+### Example of Result
+
+```shell
+$ rails depend_lister
+Level	Table	BelongsTo
+Lv1	accounts
+Lv2	follows	accounts
+Lv2	statuses	accounts
+Lv2	users	accounts
+Lv3	favourites	accounts, statuses
+Lv3	mentions	accounts, statuses
+Lv3	stream_entries	accounts, statuses
+```
 
-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.
+You can copy the result and paste to Excel Sheet or Google Spread Sheet.
 
-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).
+|  Level | Table | BelongsTo |
+| --- | --- | --- |
+|  Lv1 | accounts |  |
+|  Lv2 | follows | accounts |
+|  Lv2 | statuses | accounts |
+|  Lv2 | users | accounts |
+|  Lv3 | favourites | accounts, statuses |
+|  Lv3 | mentions | accounts, statuses |
+|  Lv3 | stream_entries | accounts, statuses |
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/depend_lister. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/depend_lister/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/kayamak/depend_lister. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kayamak/depend_lister).
 
 ## License
 
@@ -41,4 +67,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the DependLister project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/depend_lister/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the DependLister project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kayamak/depend_lister).

data/depend_lister.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.1"
-  spec.add_development_dependency "rake", '~> 0'
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", '~> 0'
+  spec.add_development_dependency "pry"
 end

data/lib/depend_lister/belong.rb

@@ -0,0 +1,43 @@
+class Belong
+  # Generates the hash(key: table name, value: belongs_to point table name).
+  def to_table_belongs_hash
+    # Generates the hash(key: table name, value: model).
+    table_model_hash = to_table_model_hash
+
+    all_tables = table_model_hash.keys
+    belogs = {}
+    table_model_hash.each do |table, model|
+    next unless model
+      # the model which does not exist is ignored.
+      tables = belong_tables(model)
+      # models of alias are exclusion.
+      belogs[table] = tables & all_tables
+    end
+    belogs
+  end
+
+  private
+
+  # Generates the hash(key: table name, value: model name).
+  def make_table_model_hash
+    tables = gain_tables
+    models = to_models(tables)
+    Hash[*tables.zip(models).flatten]
+  end
+
+  # Gains table names.
+  def gain_tables
+    ActiveRecord::Base.connection.tables.sort
+  end
+
+  def to_models(tables)
+    tables.map{ |table| Object.const_get(table.classify) rescue nil } 
+  end
+
+  # Gains the table name of the belongs_to point of the model.
+  def belong_tables(model)
+    model.reflect_on_all_associations(:belongs_to).map do |belong|
+      belong.name.to_s.pluralize
+    end.sort
+  end
+end

data/lib/depend_lister/depend_lister_core.rb

@@ -0,0 +1,172 @@
+require 'depend_lister/belong'
+class DependListerCore
+  LEVEL_LIMITTER = 1000
+
+  def execute
+    make_table_belongs_hash
+ 
+    level_tables_hash = to_level_tables_hash_main!
+
+    adjust_circulation_main!(level_tables_hash)
+    
+    displayed = display_hash(level_tables_hash)
+  end
+  
+  private
+
+  def make_table_belongs_hash
+    @table_belongs_hash = Belong.new.make_table_belongs_hash
+    @table_belongs_hash_bak = @table_belongs_hash.dup
+  end
+
+  def adjust_circulation_main!(level_tables_hash)
+    loop do
+      adjust_circulation!(level_tables_hash)
+      break if @table_belongs_hash.empty?
+      if level_tables_hash.keys.max > LEVEL_LIMITTER
+        puts 'over loop!'
+        break
+      end
+    end
+  end
+
+  def adjust_circulation!(level_tables_hash)
+    unless @table_belongs_hash.empty?
+      extract_no_belong!
+      table, blong = find_circulation
+      if table
+        @table_belongs_hash[table] = []
+        @table_belongs_hash[blong] = []
+        next_level = level_tables_hash.keys.max + 1
+        next_level_tables_hash = to_level_tables_hash_main!(next_level)
+        level_tables_hash.merge!(next_level_tables_hash)
+      end
+    end
+  end
+
+  def extract_belogs_to_self!
+    @table_belongs_hash.each do |table, belongs|
+      
+      if belongs.include?(table)
+        @table_belongs_hash[table] = belongs - [table]
+      end
+    end
+  end
+
+  def to_level_tables_hash_main!(level=1)
+    extract_belogs_to_self!
+    level_tables_hash = {}
+    top_tables = to_top_tables!
+    level_tables_hash[level] = top_tables
+    loop do
+      level += 1
+      next_hash = to_level_tables_hash!(level, level_tables_hash)
+      level_tables_hash.merge!(next_hash)
+      break if level_tables_hash[level].empty?
+      if level > LEVEL_LIMITTER
+        puts 'over loop!!'
+        break
+      end
+    end
+    level_tables_hash
+  end
+
+  def extract_no_belong!
+    tables = @table_belongs_hash.keys
+    @table_belongs_hash.each do |table, belongs|
+      @table_belongs_hash[table] = belongs.select { |belong| tables.include?(belong) }
+    end
+  end
+
+  def find_circulation
+    tables = @table_belongs_hash.keys
+    @table_belongs_hash.each do |table, belongs|
+      belongs.each do |belong|
+        # the belong without a reference point is inapplicable.
+        next unless tables.include?(belong)
+        # belog with a reference point.
+        next_belongs = @table_belongs_hash[belong]
+        if next_belongs.include?(table)
+          # When former table is included in reference point belog
+          return [table, belong].sort
+        end
+      end
+    end
+    return [nil, nil]
+  end
+
+  def to_top_tables!
+    # Gains table names without belongs_to
+    top_tables = @table_belongs_hash.select do |table, belongs|
+      if belongs.empty?
+        @table_belongs_hash.delete(table)
+      end
+      belongs.empty?
+    end.keys
+    top_tables.sort
+  end
+
+  # Converts it into the hash(key: level, value: table name).
+  def to_level_tables_hash!(level, level_tables_hash)
+    # Gains table names of level-1
+    prev_levels = []
+    (2..level).each do |level|
+      prev_levels << level_tables_hash.fetch(level-1, [])
+    end
+    prev_levels.flatten!
+
+    # A table name of level-1 selects 
+    # the level of the table name of 
+    # the belongt_to point as level
+    @table_belongs_hash.each do |table, belongs|
+      found = false
+      belongs.each do |belong|
+        if prev_levels.include?(belong)
+          found = true
+          break
+        end
+      end
+      if found
+        level_tables_hash[level] ||= []
+        level_tables_hash[level] << table
+      end
+    end
+    # Gains the table name that belongs of 
+    # @table_belongs_hash was included in 
+    # the table of the previous level and
+    # exclude it from level_tables_hash[level]
+    extract_tables = []
+    @table_belongs_hash.each do |table, belongs|
+      unless belongs.to_set.subset?(prev_levels.to_set)
+        # When all belongs is not included in prev_levels
+        extract_tables << table
+      end
+    end
+    level_tables_hash[level] ||= []
+    level_tables_hash[level] -= extract_tables
+
+    level_tables_hash[level].each do |table|
+      @table_belongs_hash.delete(table)
+    end
+    level_tables_hash
+  end
+
+  def debug_hash(hash)
+    hash.each{|key, value| puts "#{key}:#{value}" }
+  end
+
+  def display_hash(level_tables_hash)
+    displayes = []
+    displayes << "Level\tTable\tBelongsTo"
+    level_tables_hash.each do |level, tables|
+      tables.each do |table|
+        blongs = @table_belongs_hash_bak[table].join(', ')
+        displayes << "Lv#{level}\t#{table}\t#{blongs}"
+      end
+      displayes << "Lv#{level}\t\t" if tables.empty?
+    end
+    result =  displayes.join("\n")
+    puts result
+    result
+  end
+end

data/lib/depend_lister/version.rb

@@ -1,3 +1,3 @@
 module DependLister
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/tasks/depend_lister.rake

@@ -1,143 +1,7 @@
-desc "依存関係順のテーブル一覧"
+require "depend_lister/depend_lister_core"
+
+desc "Table list of dependence order"
 task depend_lister: :environment do
-  DependListerMain.new.execute
+  DependListerCore.new.execute
 end
 
-class DependListerMain
-  def execute
-    tables = gain_tables
-    models = to_models(tables)
-    # テーブル名がキーで値がモデルのハッシュを生成
-    table_model_hash = to_table_model_hash(tables, models)
-    # テーブル名がキーで値がbelongs_to先テーブル名のハッシュを生成
-    table_belongs_hash = to_table_belongs_hash(table_model_hash, tables)
-    #debug_hash(table_belongs_hash)
-    # レベルがキーで値がテーブル名のハッシュを生成
-    level_table_hash = to_level_table_hash_main(table_belongs_hash)
-    # レベルを整理する
-    organized_level_table_hash = organize_level(level_table_hash, table_belongs_hash)
-    display_hash(organized_level_table_hash, table_belongs_hash)
-  end
-
-  private
-  
-  def organize_level(level_table_hash, table_belongs_hash)
-    organized_level_table_hash = {}
-    pre_tables = []
-    level_table_hash.each do |level, tables|
-      if level == 1
-        organized_level_table_hash[level] = tables
-        pre_tables = tables
-        next
-      end
-      exist_belongs = []
-      tables.each do |table|
-        belongs = table_belongs_hash.fetch(table, [])
-        exist_belongs << belongs.find{ |belong| pre_tables.include?(belong) }
-      end
-      exist_belongs.compact!
-      if exist_belongs.empty?
-        level_tables = organized_level_table_hash[level-1] || []
-        level_tables << tables
-        organized_level_table_hash[level-1] = level_tables.flatten
-        pre_tables << tables
-      else
-        organized_level_table_hash[level] = tables
-        pre_tables = tables
-      end
-    end
-    organized_level_table_hash
-  end
-
-  def to_level_table_hash_main(arg_table_belongs_hash)
-    table_belongs_hash = arg_table_belongs_hash.dup
-    level = 0;
-    level_table_hash = {}
-    loop do
-      level += 1
-      level_table_hash.merge!(to_level_table_hash!(table_belongs_hash, level))
-      break if table_belongs_hash.empty?
-      raise 'over loop' if level > 99
-    end
-    level_table_hash
-  end
-
-  # テーブル名を取得
-  def gain_tables
-    ActiveRecord::Base.connection.tables.sort
-  end
-
-  def to_models(tables)
-    tables.map{ |table| Object.const_get(table.classify) rescue nil } 
-  end
-
-  # テーブル名がキーで値がモデルのハッシュを生成
-  def to_table_model_hash(tables, models)
-    Hash[*tables.zip(models).flatten]
-  end
-
-  # テーブル名がキーで値がモデルのハッシュを生成
-  def models_per_table(tables, models)
-    Hash[*tables.zip(models).flatten]
-  end
-
-    # テーブル名がキーで値がbelongs_to先テーブルのハッシュを生成
-  def to_table_belongs_hash(table_model_hash, all_tables)
-    belogs = {}
-    table_model_hash.each do |table, model|
-      next unless model # モデルが存在しないtableは無視する
-      tables = belong_tables(model)
-      # 別名のmodelやparents(自身のモデルをbelongs_toのみしているものは)は除外
-      belogs[table] = tables & all_tables
-    end
-    belogs
-  end
-
-  # モデルのbelongs_to先のテーブル名を取得
-  def belong_tables(model)
-    model.reflect_on_all_associations(:belongs_to).map do |belong|
-      belong.name.to_s.pluralize
-    end.sort
-  end
-
-  # ハッシュが空ではなかったら1.から繰り返す。
-  def to_level_table_hash!(table_belongs_hash, level)
-    level_table_hash = {}
-    # 1. ハッシュの値が空のテーブル名のテーブル名を空テーブル名を取得する。
-    top_tables = table_belongs_hash.select do |table, belongs|
-      belongs.empty?
-    end.keys
-    if top_tables.empty?
-      top_tables = table_belongs_hash.select do |table, belongs|
-        belongs.size == 1
-      end.keys
-    end
-    # 2. 空テーブル名をレベルiとする。
-    level_table_hash[level] = top_tables
-    # 3. ハッシュから空テーブル名をキーにして除去する。
-    top_tables.each do |table|
-      table_belongs_hash.delete(table)
-    end
-    # 4. ハッシュの値から空テーブル名を削除する。
-    tables = table_belongs_hash.keys
-    tables.each do |table|
-      belongs = table_belongs_hash[table]
-      table_belongs_hash[table] = belongs - top_tables
-    end
-    level_table_hash
-  end
-
-  def debug_hash(hash)
-    hash.each{|key, value| puts "#{key}:#{value}" }
-  end
-
-  def display_hash(level_table_hash, table_belongs_hash)
-    puts "Level\tTable\tBelongsTo"
-    level_table_hash.each do |level, tables|
-      tables.each do |table|
-        blongs = table_belongs_hash[table].join(', ')
-        puts "Lv#{level}\t#{table}\t#{blongs}"
-      end
-    end
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: depend_lister
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Keiichi Kayama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,6 +26,20 @@ dependencies:
         version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -39,17 +53,17 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: depend_lister is a command line tool which displays a list sorted by
@@ -61,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gem/credentials"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -74,6 +89,8 @@ files:
 - bin/setup
 - depend_lister.gemspec
 - lib/depend_lister.rb
+- lib/depend_lister/belong.rb
+- lib/depend_lister/depend_lister_core.rb
 - lib/depend_lister/version.rb
 - lib/tasks/depend_lister.rake
 homepage: https://github.com/kayamak/depend_lister