merge_excel 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7d9194cae8de5e57f5b2c828ed06b84a8bcd64d
-  data.tar.gz: c23be5c9b741ad107636391285f2b90013040c38
+  metadata.gz: 8fd22531f7b258fb03b65e156d56e444b8e8dcab
+  data.tar.gz: f8beda50851348cda57c4eebbc33183101e2dab8
 SHA512:
-  metadata.gz: 411b29d822d1dea25e569bfa1672f3c788e97562cb67c86a4d08b53635dd13c8a4e8eea954bd136b9a45ea70c26522e0395a5703e5bb89a445bc874c228ee1ac
-  data.tar.gz: 38d08dc4376f337ebf92276229b280c57803650a82379751bd771ff39e3188c61696fa1250fb81f9e8abe6bd8b7ba468526365ba5c4eea43f392924cc3ea080b
+  metadata.gz: 927b150ba12e3f7cb492b1f97f072d4301600fe4a7be8aebd5dc72eb4bc17b56dae6443121071c3f51e527548fb146c94a60053eb525b0c6ead9a23615d5d052
+  data.tar.gz: 527e7f72007805c5e35c5df65f33877d50d864b7761d5b192cd35407d7da8f67be990596e3e635531fbc582fa2dbd0dacfa739b12e4d9e92b9281d624b23f390

data/README.md

@@ -61,7 +61,66 @@ me.merge merged_file_path
 
 In this example will be merged only '.xls' files, of which only the columns from 0 to 5 of the second sheet.
 
+#### Options explanation
 
+Note that all indexes (sheets, rows and columns) are 0-based.
+
+- `selector_pattern` is used by `Dir.glob` method for filtering files inside the source directory. Default: `"*.{xls|xlsx}"`.
+
+- `sheets_idxs` permit to select the sheets to import/merge. Pass an array with indexes (0-based) or `:all`. Default: `:all`.
+
+- pass an `{ sheet_index => rules }` hash to `data_rows` in order to specify which rows and column you want to import. You can pass `:any` in place of the `sheet_index` for default rules.
+Rules:
+    - `header_row` set the header row index. Put `:missing` to omit the header. Default is `0`
+    - `data_starting_row` set the index of the **first row** to import, default is `1`
+    - `data_first_column` set the index of the **first column** to import, default is `0`
+    - `data_last_column` set the index of the **last column** to import, default is `:last`
+
+- pass an `{ sheet_index => rules }` hash to `extra_columns` in order to specify extra columns you want to be added to the final merge (for example you want to insert the filename you get the data). Rules:
+  - `position` define the column position of extra data, you can put at `:beginning` or  `:end`
+  - `data` define an array of desired extra data
+    - `type` can be `:filename` if you want to add filename info or `:cell_value` if you want to pick extra info from a cell
+    - `label` allow you to set extra data header name
+    - when you select `:cell_value` you have to specify `sheet_idx`, `row_idx` and `col_idx`.
+
+Another example:
+
+```ruby
+options = {
+  sheets_idxs:  :all,
+  data_rows: {
+    1 => {
+      header_row: 0,
+      data_starting_row: 1,
+      data_first_column: 0 # all columns
+    },
+    :any => {
+      header_row: :missing,
+      data_starting_row: 1,
+      data_first_column: 0,
+      data_last_column: 5
+    }
+  },
+  extra_columns: {
+    any: {
+      position: :beginning,
+      data: [
+        {
+          type: :filename,
+          label: "Filename"
+        },
+        {
+          type: :cell_value,
+          label: "Company",
+          sheet_idx: 0,
+          row_idx: 10,
+          col_idx: 3,
+        }
+      ]
+    }
+  }
+}
+```
 
 
 ## Development

data/lib/merge_excel.rb

@@ -22,5 +22,5 @@ require "merge_excel/extensions/rubyXL/workbook"
 require "merge_excel/settings/parser"
 require "merge_excel/settings/data_row"
 require "merge_excel/settings/data_rows"
-require "merge_excel/settings/extra_data_row"
-require "merge_excel/settings/extra_data_rows"
+require "merge_excel/settings/extra_column"
+require "merge_excel/settings/extra_columns"

data/lib/merge_excel/data_row.rb

@@ -1,10 +1,10 @@
 module MergeExcel
   class DataRow
     attr_reader :array
-    
-    def initialize(array, extra_data_hash, book)
-      if extra_data_hash
-        extra_array = extra_data_hash.data.map do |e|
+
+    def initialize(array, extra_col_hash, book)
+      if extra_col_hash
+        extra_array = extra_col_hash.data.map do |e|
           case e.type
           when :filename
             book.filename
@@ -14,7 +14,7 @@ module MergeExcel
             # error?
           end
         end
-        case extra_data_hash.position
+        case extra_col_hash.position
         when :beginning
           @array = extra_array + array
         else

data/lib/merge_excel/header.rb

@@ -1,10 +1,10 @@
 module MergeExcel
   class Header
-    def initialize(array, extra_data_hash)
+    def initialize(array, extra_col_hash)
 
-      if extra_data_hash
-        extra_array = extra_data_hash.data.map{|e| e.label}
-        case extra_data_hash.position
+      if extra_col_hash
+        extra_array = extra_col_hash.data.map{|e| e.label}
+        case extra_col_hash.position
         when :beginning
           @array = extra_array + array
         else

data/lib/merge_excel/settings/{extra_data_row.rb → extra_column.rb}

@@ -1,10 +1,9 @@
 module MergeExcel
   module Settings
-    class ExtraDataRow
-      # DEFAULT_EXTRA_DATA_ROW_CONFIG = {position: :beginning, data: [{ type: :filename, label: "Filename" }]}
-      DEFAULT_EXTRA_DATA_ROW_CONFIG = {}
+    class ExtraColumn
+      DEFAULT_EXTRA_COLUMN_CONFIG = {}
 
-      class FilenameExtraDataRow
+      class FilenameExtraColumn
         TYPE = :filename
         attr_reader :label, :type
         def initialize(label)
@@ -13,7 +12,7 @@ module MergeExcel
         end
       end
 
-      class CellValueExtraDataRow
+      class CellValueExtraColumn
         TYPE = :cell_value
         attr_reader :label, :type, :sheet_idx, :row_idx, :col_idx
         def initialize(label, coordinates_hash)
@@ -38,21 +37,21 @@ module MergeExcel
       def read_data_array(array)
         array.each do |h|
           if h[:type]==:filename
-            @data << FilenameExtraDataRow.new(h.fetch(:label){"Filename"})
+            @data << FilenameExtraColumn.new(h.fetch(:label){"Filename"})
           elsif h[:type]==:cell_value
-            @data << CellValueExtraDataRow.new(h.fetch(:label){"Field"}, h)
+            @data << CellValueExtraColumn.new(h.fetch(:label){"Field"}, h)
           end
         end
       end
 
 
       def self.with_defaults
-        new(DEFAULT_EXTRA_DATA_ROW_CONFIG)
+        new(DEFAULT_EXTRA_COLUMN_CONFIG)
       end
 
       private
       def validate_position
-        raise "Problem with 'extra_data' settings: 'position' must be :beginning or :end" unless [:beginning, :end].include?(@position)
+        raise "Problem with 'extra_column' settings: 'position' must be :beginning or :end" unless [:beginning, :end].include?(@position)
       end
     end
   end

data/lib/merge_excel/settings/{extra_data_rows.rb → extra_columns.rb}

@@ -1,6 +1,6 @@
 module MergeExcel
   module Settings
-    class ExtraDataRows
+    class ExtraColumns
       def initialize
         @hash = {}
       end
@@ -8,14 +8,14 @@ module MergeExcel
       def insert(sheet_idx, h)
         # h: {:any=>{:position=>:beginning, :data=>{:type=>:filename, :heading_text=>"Filename"}}}
         validate_sheet_idx sheet_idx
-        @hash[sheet_idx] = ExtraDataRow.new(h)
+        @hash[sheet_idx] = ExtraColumn.new(h)
       end
 
       def get(sheet_idx) # a number>=0 or :any
         validate_sheet_idx sheet_idx
         @hash.fetch(sheet_idx) do
           @hash.fetch(:any) do
-            @hash[:any] = ExtraDataRow.with_defaults
+            @hash[:any] = ExtraColumn.with_defaults
           end
         end
       end
@@ -23,9 +23,9 @@ module MergeExcel
       private
       def validate_sheet_idx(sheet_idx)
         if sheet_idx.is_a?(Integer)
-          raise "Problem with 'extra_data_rows' settings: sheet indexes must be >=0" if sheet_idx<0
+          raise "Problem with 'extra_columns' settings: sheet indexes must be >=0" if sheet_idx<0
         elsif sheet_idx!=:any
-          raise "Problem with 'extra_data_rows' settings: sheet indexes must be an integer or :any symbol"
+          raise "Problem with 'extra_columns' settings: sheet indexes must be an integer or :any symbol"
         end
       end
     end

data/lib/merge_excel/settings/parser.rb

@@ -1,12 +1,17 @@
 module MergeExcel
   module Settings
     class Parser
-      attr_reader :selector_pattern, :sheets_idxs, :data_rows, :extra_data_rows
+      attr_reader :selector_pattern, :sheets_idxs, :data_rows, :extra_columns
       def initialize(hash)
         @selector_pattern  = hash.fetch(:selector_pattern){ "*.{xls,xlsx}" }
         read_sheets_index    hash.fetch(:sheets_idxs){ :all }
         read_data_rows       hash.fetch(:data_rows){ {any: DataRow::DEFAULT_DATA_ROW_CONFIG } }
-        read_extra_data_rows hash.fetch(:extra_data_rows){   {any: ExtraDataRow::DEFAULT_EXTRA_DATA_ROW_CONFIG } }
+
+        if hash.has_key?(:extra_data_rows) # legacy setting
+          read_extra_columns   hash.fetch(:extra_data_rows){ {any: ExtraColumn::DEFAULT_EXTRA_COLUMN_CONFIG } }
+        else
+          read_extra_columns   hash.fetch(:extra_columns){ {any: ExtraColumn::DEFAULT_EXTRA_COLUMN_CONFIG } }
+        end
       end
 
       def all_sheets?
@@ -35,11 +40,11 @@ module MergeExcel
         end
       end
 
-      def read_extra_data_rows(h)
+      def read_extra_columns(h)
         # {:any=>{:position=>:beginning, :data=>[{:type=>:filename, :heading_text=>"Filename"}}]}
-        @extra_data_rows = ExtraDataRows.new
+        @extra_columns = ExtraColumns.new
         h.each_pair do |k,v|
-          @extra_data_rows.insert(k, v)
+          @extra_columns.insert(k, v)
         end
       end
     end

data/lib/merge_excel/sheet.rb

@@ -11,12 +11,12 @@ module MergeExcel
       @data_rows = []
     end
 
-    def add_header(array, extra_data)
-      @header = Header.new(array, extra_data)
+    def add_header(array, extra_columns)
+      @header = Header.new(array, extra_columns)
     end
 
-    def add_data_row(array, extra_data, book)
-      @data_rows << DataRow.new(array || [], extra_data, book).array
+    def add_data_row(array, extra_columns, book)
+      @data_rows << DataRow.new(array || [], extra_columns, book).array
     end
   end
 end

data/lib/merge_excel/version.rb

@@ -1,3 +1,3 @@
 module MergeExcel
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/merge_excel/wbook.rb

@@ -18,7 +18,7 @@ module MergeExcel
           row_idx = sh_stt.data_starting_row
           loop do
             break unless cells = sheet.row_values(row_idx, sh_stt.data_first_column, sh_stt.data_last_column)
-            sh.add_data_row(cells, @settings.extra_data_rows.get(idx), book)
+            sh.add_data_row(cells, @settings.extra_columns.get(idx), book)
             row_idx+=1
           end
         end
@@ -55,7 +55,7 @@ module MergeExcel
       sh = Sheet.new(sheet, idx)
       if sh_stt.import_header?
         arr = sheet.row_values(sh_stt.header_row, sh_stt.data_first_column, sh_stt.data_last_column)
-        sh.add_header(arr, @settings.extra_data_rows.get(idx))
+        sh.add_header(arr, @settings.extra_columns.get(idx))
       end
       @sheets << sh
       sh

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merge_excel
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Iwan Buetti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,8 +123,8 @@ files:
 - lib/merge_excel/header.rb
 - lib/merge_excel/settings/data_row.rb
 - lib/merge_excel/settings/data_rows.rb
-- lib/merge_excel/settings/extra_data_row.rb
-- lib/merge_excel/settings/extra_data_rows.rb
+- lib/merge_excel/settings/extra_column.rb
+- lib/merge_excel/settings/extra_columns.rb
 - lib/merge_excel/settings/parser.rb
 - lib/merge_excel/sheet.rb
 - lib/merge_excel/sheets.rb