fileconv 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a11710da18bbef2f204f676c21b5827f01c0a84af1aa889353e9ef44de5043d5
-  data.tar.gz: c8c62864940a00b078e76c63459646aad1898a544569df233f49bde1d2ec9445
+  metadata.gz: 1b8f07c030f514fbed40b42a39c737579023a907f7e636d3fd37714017e80bc5
+  data.tar.gz: d0115ed9453377e2cda186096c55380031550906bded00c8e5fe86422e005d72
 SHA512:
-  metadata.gz: a7ed3cbcd55d7a35fab31ffa3e372ed5a80ae207a50ae1c0076cc78c7007ad2919a19dfa39e5759a49d4bece4bcce035522280cb86bcef8ba0cd7e06eb3d6090
-  data.tar.gz: 3da1ed9b8b478a21cce27c4692e72e77010a7628636ec1881a59e4b2f0bf462bff3cbf796095e08c9a33a1db2cf64d2fe0b412a63cd54aaa6cb36e8f645e6f54
+  metadata.gz: 141302bfc7a4cc4a8b1bcb8fc6f97fb99064f1930621647602bc0f79c6db9fae6d5b13443b7880d31df614ce1dec27f17d70d90a3983d911efb4b8c69b1c5265
+  data.tar.gz: d420660694a1ec760285f38470e0b64cf4312b7fadb6edaef0791c63a503b165e150110300572989b75ecffb5d39b545bc5f96b232a5313707feafddafaceb62

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fileconv (0.1.0)
+    fileconv (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # Fileconv
 
-Extensible multi-file convertor. Simple text file, CSV file, JSON file binary file and so on.
+Extensible multi-file convertor. Simple text file, CSV file, JSON file, binary file and so on.
 
 `fileconv` gem is a simple to use and extensible library to convert multi-file format. You can extend your class with `MetaConvertor` and convert files into various format.
 
@@ -25,7 +25,7 @@ Or install it yourself as:
 You have to do a few things to build a Convertor with `fileconv` gem.
 
 - include `MetaConvertor`(e.g. `Fileconv::Line`) into your object,
-- add several hooks(e.g. `input_ext`) if you need.
+- add some hooks(e.g. `input_ext`) if you need.
 
 Lets start with a simple example. It will be a convertor for simple text files.
 
@@ -89,22 +89,16 @@ the convertor convert it into:
 3: 333
 ```
 
-### Variables
-
-|variable|scope|descripton|
-|---|---|---|
-|acc|file|accumulator for a file|
-|@meta|convertor|meta data for the convertor|
-|@opts|convertor|options for the convertor(`#conv` can receive options.)|
-
 ### Convertor Hooks
 
+You can overwrite convertor hooks if you need. The default action is that a converter copies all files in the current directory to an “output” directory. The convertor make the "output" directory in the current directory if it doesn't exist.
+
 |hook|default|description|
 |---|---|---|
 |input_dir|"."(current directory)|input Directory|
 |input_ext|`nil` (all files)|input extension|
 |output_dir|"output"|output directory|
-|input_files|`nil` (use `input_dir`)|input files(array of file names)|
+|input_files(files)|`files`|input files|
 |init_conv|`nil`|init convertor hook|
 |init_acc(acc)|`nil`|init accumulator hook|
 |read_file(filename, acc)|`nil` (use default reader)|read file hook|
@@ -114,10 +108,28 @@ the convertor convert it into:
 |result_filename|"result.txt"|result filename|
 |conv_result|`nil`|conversion result|
 
+Input files is selected by `input_dir` and `input_ext`. you can overwrite it with `#input_files` hooks.
+
+The most commonly used hooks are：
+
+- `#input_ext`
+- `#convert_line`
+- `#convert_file`
+- `#conv_result`
+
+### Convertor Variables
+
+You can use several convertor variables. Convertor variables are `Hash` type and have a specific scope. `acc` has single file scope, which means that it is initialized for each file. `@meta` and `@opts` is valid in a convertor. `@opts` variable is set by `#conv` method that takes user options. you can use `@meta` variable for any purpose.
+
+|variable|scope|descripton|
+|---|---|---|
+|acc|file|accumulator for a file|
+|@meta|convertor|meta data for the convertor|
+|@opts|convertor|options for the convertor|
 
-### Default MetaConvertor
+### Default MetaConvertors
 
-`fileconv` gem have several default MetaConvertor:
+`fileconv` gem have several default MetaConvertors. MetaConverters are mainly intended to be included by a converter.
 
 |MetaConvertor|mode|description|
 |---|---|---|
@@ -127,21 +139,21 @@ the convertor convert it into:
 |File|File|`File` convertor|
 |JSON|File|JSON convertor|
 
-A convertor(includes MetaConvertor) can be divided into two modes.
+Convertors(includes MetaConvertors) can be divided into two modes.
 
 - Line Mode
-  - `#convert_line` hooks is called
+  - `#convert_line` hooks is called.
   - e.g. `Line`, `CSV`
 - File Mode
-  - `#convert_line` hooks is not called
+  - `#convert_line` hooks is not called.
   - e.g. `Data`, `File`, `JSON`
 
-Let's see a JSON example.
+Let's see a JSON MetaConvertor usage.
 
 ```ruby
 require 'fileconv'
 
-class ModifyJSON
+class ModifyJSONConvertor
   include Fileconv::JSON
 
   def input_ext
@@ -156,7 +168,7 @@ class ModifyJSON
   end
 end
 
-ModifyJSON.new.conv
+ModifyJSONConvertor.new.conv
 ```
 
 original file (`address.json`) :
@@ -203,10 +215,12 @@ module Fileconv
 end
 ```
 
-MetaConvertor can use below hooks:
+MetaConvertors can use below hooks:
 
 - pre_init_conv
 - post_init_conv
+- pre_input_files
+- post_input_files
 - pre_init_acc
 - post_init_acc
 - pre_convert_file

data/example/line/input_files.rb

@@ -6,7 +6,7 @@ class InputFiles
     "txt"
   end
 
-  def input_files
+  def input_files(files)
     ["test1.txt", "test3.txt"]
   end
 

data/lib/fileconv/base.rb

@@ -1,46 +1,56 @@
 module Fileconv
   module MetaConvertor
-    # Pre hook for {Convertor#init_conv}
+    # Pre-hook for {Convertor#init_conv}
     def pre_init_conv
     end
 
-    # Post hook for {Convertor#init_conv}
+    # Post-hook for {Convertor#init_conv}
     def post_init_conv
     end
 
-    # Pre hook for {Convertor#init_acc}
+    # Pre-hook for {Convertor#input_files}
+    def pre_input_files(files)
+      files
+    end
+
+    # Post-hook for {Convertor#input_files}
+    def post_input_files(files)
+      files
+    end
+
+    # Pre-hook for {Convertor#init_acc}
     def pre_init_acc(acc)
     end
 
-    # Post hook for {Convertor#init_acc}
+    # Post-hook for {Convertor#init_acc}
     def post_init_acc(acc)
     end
 
-    # Pre hook for {Convertor#convert_file}
+    # Pre-hook for {Convertor#convert_file}
     def pre_convert_file(file, acc)
       file
     end
 
-    # Pre hook for {Convertor#convert_line}
+    # Pre-hook for {Convertor#convert_line}
     def pre_convert_line(line, acc)
       line
     end
 
-    # Post hook for {Convertor#convert_line}
+    # Post-hook for {Convertor#convert_line}
     def post_convert_line(line, acc)
       line
     end
 
-    # Pre hook for {Convertor#convert_file}
+    # Pre-hook for {Convertor#convert_file}
     def post_convert_file(file, acc)
       file
     end
 
-    # Pre hook for {Convertor#conv_result}
+    # Pre-hook for {Convertor#conv_result}
     def pre_conv_result
     end
 
-    # Post hook for {Convertor#conv_result}
+    # Post-hook for {Convertor#conv_result}
     def post_conv_result(result)
       result
     end
@@ -67,10 +77,11 @@ module Fileconv
     end
 
     # Input files
-    # @return [Array<String>,nil]
-    # @note ignore {#input_dir} if this method return non-nil
-    # @note select files by {#input_dir} and {#input_ext} if this method return nil
-    def input_files
+    # @param [Array<string>] files input files
+    # @return [Array<String>]
+    # @note you can overwrite default input files
+    def input_files(files)
+      files
     end
 
     # Initialize the convertor
@@ -151,28 +162,28 @@ module Fileconv
         raw = ::File.read(filename, @opts[:read_file_opts]) unless raw
       end
 
-      pre_converted_file = pre_convert_file(raw, acc)
+      converted_file = pre_convert_file(raw, acc)
       if @opts[:line_mode]
         # Line mode
-        pre_converted_file = process_line(pre_converted_file, acc)
+        converted_file = process_line(converted_file, acc)
       end
 
-      converted_file = convert_file(pre_converted_file, acc)
-      post_converted_file = post_convert_file(converted_file, acc)
-      if post_converted_file
+      converted_file = convert_file(converted_file, acc)
+      converted_file = post_convert_file(converted_file, acc)
+      if converted_file
         out = output_filename(::File.basename(filename), acc)
         Dir.mkdir output_dir if !Dir.exists? output_dir
-        ::File.write(::File.join(output_dir, out), post_converted_file, @opts[:read_file_opts])
+        ::File.write(::File.join(output_dir, out), converted_file, @opts[:read_file_opts])
       end
     end
 
     def process_line(raw_lines, acc)
       lines = []
       raw_lines.each do |line|
-        pre_converted_line = pre_convert_line(line, acc)
-        converted_line = convert_line(pre_converted_line, acc)
-        post_converted_line = post_convert_line(converted_line, acc)
-        lines.push *post_converted_line
+        converted_line = pre_convert_line(line, acc)
+        converted_line = convert_line(converted_line, acc)
+        converted_line = post_convert_line(converted_line, acc)
+        lines.push *converted_line
       end
       lines
     end
@@ -188,11 +199,11 @@ module Fileconv
       init_conv()
       post_init_conv()
 
-      files = input_files()
-      unless files
-        glob = input_ext ?  "*." + input_ext : "*"
-        files = Dir.glob(::File.join(input_dir, glob))
-      end
+      glob = input_ext ?  "*." + input_ext : "*"
+      files = Dir.glob(::File.join(input_dir, glob))
+      files = pre_input_files(files)
+      files = input_files(files)
+      files = post_input_files(files)
 
       files.each do |filename|
         process_file(filename)

data/lib/fileconv/version.rb

@@ -1,3 +1,3 @@
 module Fileconv
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fileconv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - hinastory
@@ -55,29 +55,22 @@ files:
 - bin/setup
 - example/csv/add_column.rb
 - example/csv/add_header.rb
-- example/csv/output/test2.txt
 - example/csv/test.csv
 - example/csv/test2.txt
 - example/csv/with_header.rb
 - example/data/list_file.rb
 - example/data/output/result.txt
 - example/data/test.data
-- example/file/output/test.data
 - example/file/read_bytes.rb
 - example/file/test.data
 - example/json/address.json
 - example/json/modify_json.rb
-- example/json/output/address.json
 - example/json/pretty_json.rb
 - example/line/add_lineno.rb
 - example/line/count_lines.rb
 - example/line/filter_lines.rb
 - example/line/input_files.rb
 - example/line/modify_new_line.rb
-- example/line/output/test1.txt
-- example/line/output/test2.txt
-- example/line/output/test3.txt
-- example/line/output/test4.txt
 - example/line/sort_lines.rb
 - example/line/test1.txt
 - example/line/test2.txt
@@ -85,7 +78,6 @@ files:
 - example/line/test4.txt
 - example/line/uniq_line.rb
 - example/meta_convertor/csv2json.rb
-- example/meta_convertor/output/test.csv
 - example/meta_convertor/test.csv
 - fileconv.gemspec
 - lib/fileconv.rb

data/example/csv/output/test2.txt

@@ -1,4 +0,0 @@
-Name,Age
-Taro,20
-Hanako,20
-Hideki,20

data/example/file/output/test.data

@@ -1,7 +0,0 @@
-abcde
-fghij
-klmno
-pqrst
-uvwxy
-z1234
-56789

data/example/json/output/address.json

@@ -1 +0,0 @@
-[{"name":"Mike","Age":"21","country":"USA"},{"name":"Jon","Age":"33","country":"USA"}]

data/example/line/output/test1.txt

@@ -1,5 +0,0 @@
-111
-aaa
-bbb
-ccc
-ddd

data/example/line/output/test2.txt

@@ -1,7 +0,0 @@
-126
-2323
-aaaa
-aaaa
-ddds
-pppppp
-rrrr

data/example/line/output/test3.txt

@@ -1,10 +0,0 @@
-2281
-6656
-ddd
-ggg
-ggg
-kkk
-sssgg
-sssgg
-sssgg
-ttt

data/example/line/output/test4.txt

@@ -1,5 +0,0 @@
-111
-aaa
-bbb
-ccc
-ddd

data/example/meta_convertor/output/test.csv

@@ -1,17 +0,0 @@
-[
-  {
-    "Name": "Taro",
-    "Age": "22",
-    "Check": "true"
-  },
-  {
-    "Name": "Hanako",
-    "Age": "18",
-    "Check": "false"
-  },
-  {
-    "Name": "Hideki",
-    "Age": "6",
-    "Check": "false"
-  }
-]