rggen-spreadsheet-loader 0.13.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c77024dc6d24098565e522967f52f27fc66932dc789c7cdd17a74a5e2fe06440
-  data.tar.gz: e218f0064faaeadfa78e62be7b9ea806fe587db86fddc2b489b5d3feb4828a23
+  metadata.gz: 1a5c038c878bdee2d0369695504d66c0773c5778ca6ba27ad20960c525f0ef32
+  data.tar.gz: 698efcc2c97a0603b7212e35eef134a1526485bd77383bfc27a490f44a21eb87
 SHA512:
-  metadata.gz: 40e0eb3682a2550a05e2c88c447879da8a0664530db4b87d0b97d92d3789ffea2cee951fa006436997a1275cf835badd94754aa4ff8b49d12027efba33ab30be
-  data.tar.gz: f7a8e57b3d5873099aef7fd229788533a49376970c5cdedc070d71a404ca39f98e757b15ae9227ba0b1f92ae9ffc360fcc0f6111f9da732396969773ff26bac6
+  metadata.gz: 8df01bd76a566ccbbdbcd4e8efab23f20d3f7f64d8908d0cd7bbdcd6c0fe8f4aa1f4ffa1d6cc935d9843f5efaf813275e6af1f9141d188c607a19dc18490c81a
+  data.tar.gz: c806612b266d7a64e432490f96c5c9468e9d3739ae286728402e60822e82ce1b3f5cfcba4ec73d07c05b3e07490ccb49678a73c5fde86295b5f83576e4612f08

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Taichi Ishitani
+Copyright (c) 2019-2020 Taichi Ishitani
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/rggen-spreadsheet-loader.svg)](https://badge.fury.io/rb/rggen-spreadsheet-loader)
-[![Build Status](https://travis-ci.com/rggen/rggen-spreadsheet-loader.svg?branch=master)](https://travis-ci.com/rggen/rggen-spreadsheet-loader)
+[![CI](https://github.com/rggen/rggen-spreadsheet-loader/workflows/CI/badge.svg)](https://github.com/rggen/rggen-spreadsheet-loader/actions?query=workflow%3ACI)
 [![Maintainability](https://api.codeclimate.com/v1/badges/7a4090f4a7c21d29036c/maintainability)](https://codeclimate.com/github/rggen/rggen-spreadsheet-loader/maintainability)
 [![codecov](https://codecov.io/gh/rggen/rggen-spreadsheet-loader/branch/master/graph/badge.svg)](https://codecov.io/gh/rggen/rggen-spreadsheet-loader)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rggen_rggen-spreadsheet-loader&metric=alert_status)](https://sonarcloud.io/dashboard?id=rggen_rggen-spreadsheet-loader)
@@ -40,7 +40,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 
 ## Copyright & License
 
-Copyright © 2019 Taichi Ishitani. RgGen::SpreadsheetLoader is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+Copyright © 2019-2020 Taichi Ishitani. RgGen::SpreadsheetLoader is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
 
 ## Code of Conduct
 

data/lib/rggen/spreadsheet_loader.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'roo'
-require 'roo-xls'
 require_relative 'spreadsheet_loader/version'
 require_relative 'spreadsheet_loader/spreadsheet/position'
 require_relative 'spreadsheet_loader/spreadsheet/cell'
@@ -9,12 +7,16 @@ require_relative 'spreadsheet_loader/spreadsheet/row'
 require_relative 'spreadsheet_loader/spreadsheet/sheet'
 require_relative 'spreadsheet_loader/spreadsheet/book'
 require_relative 'spreadsheet_loader/spreadsheet_loader'
+require_relative 'spreadsheet_loader/csv_loader'
 require_relative 'spreadsheet_loader/roo_loader'
+require_relative 'spreadsheet_loader/xls_loader'
 
 module RgGen
   module SpreadsheetLoader
     def self.default_setup(builder)
-      builder.register_loader(:register_map, RooLoader)
+      builder.register_loader(:register_map, :spreadsheet, CSVLoader)
+      builder.register_loader(:register_map, :spreadsheet, RooLoader)
+      builder.register_loader(:register_map, :spreadsheet, XLSLoader)
     end
   end
 end

data/lib/rggen/spreadsheet_loader/csv_loader.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    class CSVLoader < Core::RegisterMap::Loader
+      include SpreadsheetLoader
+
+      support_types [:csv]
+
+      def read_spreadsheet(file, book)
+        sheet = read_csv(file)
+        sheet_name = File.basename(file, '.*')
+        book.add_sheet(sheet_name, sheet)
+      end
+
+      private
+
+      def read_csv(file)
+        require 'csv'
+        CSV.read(file)
+      end
+    end
+  end
+end

data/lib/rggen/spreadsheet_loader/roo_loader.rb

@@ -5,16 +5,24 @@ module RgGen
     class RooLoader < Core::RegisterMap::Loader
       include SpreadsheetLoader
 
-      support_types [:xlsx, :xls, :ods, :csv]
+      support_types [:xlsx, :ods]
 
       def read_spreadsheet(file, book)
-        Roo::Spreadsheet.open(file).each_with_pagename do |pagename, page|
-          page.first_row && book.add_sheet(pagename, collect_cells(page))
+        read_roo(file) do |pagename, page|
+          book.add_sheet(pagename, collect_cells(page))
         end
       end
 
       private
 
+      def read_roo(file)
+        require 'roo'
+        Roo::Spreadsheet.open(file, extension: File.extname(file))
+          .each_with_pagename do |pagename, page|
+            page.first_row && yield(pagename, page)
+          end
+      end
+
       def collect_cells(page)
         (1..page.last_row).map do |row|
           (1..page.last_column).map { |column| page.cell(row, column) }

data/lib/rggen/spreadsheet_loader/setup.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
 
 require 'rggen/spreadsheet_loader'
-RgGen.setup :'spreadsheet-loader', RgGen::SpreadsheetLoader
+RgGen.setup :'rggen-spreadsheet-loader', RgGen::SpreadsheetLoader do |builder|
+  builder.ignore_value :register_map, :spreadsheet, :register_block, :comment
+  builder.ignore_value :register_map, :spreadsheet, :register, :comment
+end

data/lib/rggen/spreadsheet_loader/spreadsheet_loader.rb

@@ -9,72 +9,65 @@ module RgGen
         Spreadsheet::Book.new(file) { |book| read_spreadsheet(file, book) }
       end
 
-      def format(book, _file)
-        book.sheets.each(&method(:process_sheet))
-      end
-
       private
 
-      def process_sheet(sheet)
-        register_block = parse_register_block(sheet)
-        sheet
-          .rows(register_start_position.row)
-          .reject { |row| row.cells.all?(&:empty_cell?) }
-          .each { |row| process_row(row, register_block) }
+      def format_layer_data(read_data, layer, _file)
+        layer != :root ? collect_layer_data(read_data, layer) : nil
       end
 
-      def parse_register_block(sheet)
-        register_map.register_block do
-          register_block_valid_values
-            .zip(register_block_cells(sheet))
-            .each { |value_name, cell| value(value_name, cell) }
-        end
+      def collect_layer_data(read_data, layer)
+        values = valid_values(layer)
+        cells = __send__("#{layer}_cells", read_data)
+        values.zip(cells).to_h
       end
 
       def register_block_cells(sheet)
         start_row = register_block_start_position.row
         start_column = register_block_start_position.column
-        Array.new(register_block_valid_values.size) do |i|
+        Array.new(valid_values(:register_block).size) do |i|
           sheet[start_row + i, start_column]
         end
       end
 
-      def process_row(row, register_block)
-        register =
-          if row[register_start_position.column].empty_cell?
-            register_block.children.last
-          else
-            parse_register(row, register_block)
-          end
-        parse_bit_field(row, register)
+      def register_cells(rows)
+        start_column = register_start_position.column
+        size = valid_values(:register).size
+        rows.first.cells(start_column, size)
       end
 
-      def parse_register(row, register_block)
-        register_block.register do
-          register_valid_values
-            .zip(register_cells(row))
-            .each { |value_name, cell| value(value_name, cell) }
-        end
+      def bit_field_cells(row)
+        start_column = bit_field_start_position.column
+        size = valid_values(:bit_field).size
+        row.cells(start_column, size)
       end
 
-      def register_cells(row)
-        start_column = register_start_position.column
-        size = register_valid_values.size
-        row.cells(start_column, size)
+      SUB_LAYERS = {
+        root: :register_block,
+        register_block: :register,
+        register: :bit_field
+      }.freeze
+
+      def format_sub_layer_data(read_data, layer, _file)
+        sub_layer = SUB_LAYERS[layer]
+        sub_layer && { sub_layer => __send__("collect_#{sub_layer}_data", read_data) }
       end
 
-      def parse_bit_field(row, register)
-        register.bit_field do
-          bit_field_valid_values
-            .zip(bit_field_cells(row))
-            .each { |value_name, cell| value(value_name, cell) }
-        end
+      def collect_register_block_data(book)
+        book.sheets
       end
 
-      def bit_field_cells(row)
-        start_column = bit_field_start_position.column
-        size = bit_field_valid_values.size
-        row.cells(start_column, size)
+      def collect_register_data(sheet)
+        sheet.rows(register_start_position.row)
+          .reject { |row| row.cells.all?(&:empty_cell?) }
+          .each_with_object([]) do |row, row_sets|
+            row[register_start_position.column].empty_cell? ||
+              (row_sets << [])
+            row_sets.last << row
+          end
+      end
+
+      def collect_bit_field_data(rows)
+        rows
       end
 
       def register_block_start_position
@@ -83,29 +76,17 @@ module RgGen
 
       def register_start_position
         @register_start_position ||=
-          Position.new(register_block_valid_values.size + 2, 1)
+          Position.new(valid_values(:register_block).size + 2, 1)
       end
 
       def bit_field_start_position
         @bit_field_start_position ||=
           begin
             column =
-              register_start_position.column + register_valid_values.size
+              register_start_position.column + valid_values(:register).size
             Position.new(0, column)
           end
       end
-
-      def register_block_valid_values
-        valid_value_lists[1]
-      end
-
-      def register_valid_values
-        valid_value_lists[2]
-      end
-
-      def bit_field_valid_values
-        valid_value_lists[3]
-      end
     end
   end
 end

data/lib/rggen/spreadsheet_loader/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module SpreadsheetLoader
-    VERSION = '0.13.0'
+    VERSION = '0.17.0'
   end
 end

data/lib/rggen/spreadsheet_loader/xls_loader.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    class XLSLoader < Core::RegisterMap::Loader
+      include SpreadsheetLoader
+
+      support_types [:xls]
+
+      def read_spreadsheet(file, book)
+        read_xls(file).each do |sheet|
+          book.add_sheet(sheet.name, sheet.rows)
+        end
+      end
+
+      private
+
+      def read_xls(file)
+        require 'spreadsheet'
+        ::Spreadsheet.open(file, 'rb') do |book|
+          book.worksheets.select { |sheet| sheet.row_count.positive? }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-spreadsheet-loader
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roo
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: roo-xls
+  name: spreadsheet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +63,7 @@ files:
 - LICENSE
 - README.md
 - lib/rggen/spreadsheet_loader.rb
+- lib/rggen/spreadsheet_loader/csv_loader.rb
 - lib/rggen/spreadsheet_loader/roo_loader.rb
 - lib/rggen/spreadsheet_loader/setup.rb
 - lib/rggen/spreadsheet_loader/spreadsheet/book.rb
@@ -72,6 +73,7 @@ files:
 - lib/rggen/spreadsheet_loader/spreadsheet/sheet.rb
 - lib/rggen/spreadsheet_loader/spreadsheet_loader.rb
 - lib/rggen/spreadsheet_loader/version.rb
+- lib/rggen/spreadsheet_loader/xls_loader.rb
 homepage: https://github.com/rggen/rggen-spreadsheet-loader
 licenses:
 - MIT
@@ -88,15 +90,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: rggen-spreadsheet-loader-0.13.0
+summary: rggen-spreadsheet-loader-0.17.0
 test_files: []