simple_tabler 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa3cb33da89108fb63317f82e46ac6d26da3172af8c78b300139253cb9c3c7c0
-  data.tar.gz: 0efcaab18aeac0c92f5b89923d95852b53b7a2658dc14ceb2c107ccb6747a9a2
+  metadata.gz: 673a1a57ecff0f6f4bf586b10cff347c3c40947c84685cf344a5fbe71ab7b13f
+  data.tar.gz: 4d10bc4df14395fea3b95050d10ba3c2e0af4896aeb60b3b1efbcf6cf0433142
 SHA512:
-  metadata.gz: 5a8570aaedb9deae427f66cdde705ff40c8012ef2e7a5a2a2392093697e22f3a736c4c666dc7ffd9f9016d5b8744ad7fa82d9cc88b2ea8dc3c028ea7c22425f7
-  data.tar.gz: 2c89697b977645a451c30464a24fe432f0243c3825e649323901fef17012f44abbaf66bfe37f0ef70bf800ea56548185cc054505d9844f509171456b0160d042
+  metadata.gz: 52a7b43f4b9bd90845ee426d257a88638c1fa57feaa0b685e8b03460e146b83093d3298e62ae1e3fb075bb407e5c543ba05444a7aef143f84a0ea01dde065077
+  data.tar.gz: dcb3e76b5778a510ee78e11b7f1720c2055b075c2a9c81f065e47447aac8c57aa3bb0d02dbb880a01252701ff0bb468694af5c6fffc071f7a9bd5caf7868e9c9

data/README.md

@@ -1,32 +1,59 @@
-# SimpleTabler
+# Simple Tabler
 
-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/simple_tabler`. To experiment with that code, run `bin/console` for an interactive prompt.
+Simple Tabler helps you to make a table in Terminal
 
-TODO: Delete this and the text above, and describe your gem
+It can be used as a gem.(https://rubygems.org/gems/simple_tabler)
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add simple_tabler to your Gemfile.
 
-    $ bundle add simple_tabler
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install simple_tabler
+```Gemfile
+gem 'simple_tabler', '~> 0.1.0'
+```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-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.
-
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+First of all, you should import the module Simple Tabler.
+
+```.rb
+require "simple_tabler"
+```
+
+Now, you can create a table from an array like blow.
+
+```.rb
+a = [
+  [
+    "ABCDE_Mail",
+    "example@example.com",
+    "abcdefg_" * 10
+  ],
+  [
+    "XYZ_TV",
+    "Taro Yamada",
+    "qwerty" * 10
+  ]
+]
+
+puts a.generate_table(["Service", "username", "password"], 30)
+
+#|============================================================================================|
+#|Service                       |username                      |password                      |
+#|============================================================================================|
+#|ABCDE_Mail                    |example@example.com           |abcdefg_abcdefg_abcdefg_abcdef|
+#|                              |                              |g_abcdefg_abcdefg_abcdefg_abcd|
+#|                              |                              |efg_abcdefg_abcdefg_          |
+#|--------------------------------------------------------------------------------------------|
+#|XYZ_TV                        |Taro Yamada                   |qwertyqwertyqwertyqwertyqwerty|
+#|                              |                              |qwertyqwertyqwertyqwertyqwerty|
+#|                              |                              |                              |
+#|--------------------------------------------------------------------------------------------|
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_tabler.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Takahashi-Riki/simple_tabler.
 
 ## License
 

data/lib/simple_tabler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleTabler
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/simple_tabler.rb

@@ -6,51 +6,58 @@ require_relative "table_from_array"
 class Array; include SimpleTabler; end
 
 module SimpleTabler
+  CORRECT_OBJECTS = [String, Numeric, Symbol, TrueClass, FalseClass]
+
+  def generate_table(column_names=nil, scale=20)
+    if !dimension_equal_two?
+      raise ArgumentError, "The depth of array should be two."
+    elsif !child_array_size_same?
+      raise ArgumentError, "All child arrays should have same amount of element."
+    elsif !element_type_correct?
+      raise ArgumentError, "All child arrays should have elements which is kind of allowed class.\nAllowed class is String, Numeric, Symbol, TrueClass, FalseClass"
+    elsif !column_names.nil? && !column_size_correct?(column_names)
+      raise ArgumentError, "All child arrays should have same amount of element with column names you passed as an argument."
+    end
+
+    table_generated_from_array = TableFromArray.new(self, column_names, scale)
+    return table_generated_from_array.content_of_table
+  end
+
+  # return true if dimension of array equal two.
+  # ex. [["hoge", "fuga"], ["hoge", "fuga"]]
+  #     => true
+  #     [["hoge", "fuga"], ["hoge", "fuga", ["hoge"]]]
+  #     => false
   def dimension_equal_two?
     self.each do |child_array|
-      if !child_array.kind_of?(Array)
-        return false
-      elsif child_array != child_array.flatten
-        return false
-      end
+      return false unless child_array.kind_of?(Array)
+      return false unless child_array == child_array.flatten
     end
     return true
   end
 
+  # return true if all of the child array has same length of item.
+  # ex. [["1", "2"], ["1", "2"]]
+  #     => true
+  #     [["1", "2"], ["1", "2", "3"]]
+  #     => false
   def child_array_size_same?
     child_array_sizes = self.map{|child_array| child_array.size}
     child_array_sizes.uniq.size == 1
   end
 
+  # return true if all of array items are kind of CORRECT_OBJECTS.
   def element_type_correct?
-    correct_object_types = [String, Numeric, Symbol, TrueClass, FalseClass]
     self.each do |child_array|
       child_array.each do |element|
-        result_each_kind_of = correct_object_types.map{|object_type| element.kind_of?(object_type)}
-        return false if !result_each_kind_of.include?(true)
+        return false unless CORRECT_OBJECTS.any?{|object_type| element.kind_of?(object_type)}
       end
     end
     return true
   end
 
+  # return true if array size and column size is same.
   def column_size_correct?(column_names)
     self[0].size == column_names.size
   end
-
-  def generate_table(column_names=nil, scale=20)
-    if !dimension_equal_two?
-      raise ArgumentError, "The depth of array should be two."
-    elsif !child_array_size_same?
-      raise ArgumentError, "All child arrays should have same amount of element."
-    elsif !element_type_correct?
-      raise ArgumentError, "All child arrays should have elements which is kind of allowed class.\nAllowed class is String, Numeric, Symbol, TrueClass, FalseClass"
-    elsif !column_names.nil? && !column_size_correct?(column_names)
-      raise ArgumentError, "All child arrays should have same amount of element with column names you passed as an argument."
-    end
-    column_size                = self[0].size
-    table_generated_from_array = TableFromArray.new(column_size, column_names, scale)
-    table_generated_from_array.add_header
-    table_generated_from_array.add_content(self)
-    return table_generated_from_array.content_of_table
-  end
 end

data/lib/table_from_array.rb

@@ -1,17 +1,18 @@
 class TableFromArray
-  attr_reader :content_of_table, :column_names
+  attr_reader :content_of_table
   
-  def initialize(column_size, column_names, scale)
+  def initialize(array, column_names, scale)
     @content_of_table = ""
-    @column_size      = column_size
-    @column_names     = column_names
-    @scale            = scale
+    @column_size = array[0].size
+    @scale  = scale
+    self.add_header(column_names)
+    self.add_content(array)
   end
 
-  def add_header
-    if @column_names
+  def add_header(column_names=nil)
+    if column_names
       add_separation("=")
-      add_row(@column_names)
+      add_row(column_names)
       add_separation("=")
     else
       add_separation("-")
@@ -32,13 +33,13 @@ class TableFromArray
 
     def add_row(row_materials)
       content_of_row  = ""
-      number_of_lines = max_length_of_array_element(row_materials) / @scale + 1
-      for i in 0...number_of_lines do
+      number_of_lines = (max_length_of_array_element(row_materials).to_f / @scale).ceil
+      (0...number_of_lines).each do |i|
         line = "|"
-        for row_material in row_materials do
+        row_materials.each do |row_material|
           row_material_sliced_for_this_line = row_material[@scale*i...@scale*(i+1)].to_s
-          space_to_fill_the_blank           = " " * (@scale - row_material_sliced_for_this_line.size)
-          line                             += row_material_sliced_for_this_line + space_to_fill_the_blank + "|"
+          space_to_fill_the_blank = " " * (@scale - row_material_sliced_for_this_line.size)
+          line += row_material_sliced_for_this_line + space_to_fill_the_blank + "|"
         end
         content_of_row += line + "\n"
       end
@@ -46,7 +47,6 @@ class TableFromArray
     end
 
     def add_separation(mark)
-      separation         = "|" + mark * (@scale * @column_size + @column_size - 1) + "|" + "\n"
-      @content_of_table += separation
+      @content_of_table += "|" + mark * (@scale * @column_size + @column_size - 1) + "|" + "\n"
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_tabler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - mew3880
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: