rggen-spreadsheet-loader 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72ae0f3ce551504e8d03a34b60dd745c9ccae7b9029f66e5ea1bffb6fac744b8
+  data.tar.gz: 6fd10b3cdc393388de294c080326316d1eb45dd9c7a7e803d234d2392ab8e80d
+SHA512:
+  metadata.gz: e5f6e0edac2b6406c0a3abc4981373b1a63898bde5931578450668bcc5d5888ec537b976f94b452279cba9d09b089c6f61a4ed06e4d358ad52b2317eef8b3bcb
+  data.tar.gz: ceae9e59744d315fdc3986a9fe274b2555ba74db34b5cebdfda9893184ed0195785d216b2fc8e843239df70b248c1dee08ec263078db4aa2868c6c37293c4579

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at taichi730@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+[![Build Status](https://travis-ci.org/rggen/rggen-spreadsheet-loader.svg?branch=master)](https://travis-ci.org/rggen/rggen-spreadsheet-loader)
+[![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)
+
+# RgGen::SpreadsheetLoader
+
+RgGen::SpreadsheetLoader adds ability to load register map documents written in spreadsheet format.
+
+Supported spreadsheet formats are listed below:
+
+* MS Excel (xlsx and xls)
+* LibreOffice/OpenOffice (ods)
+* CSV
+
+## Installation
+
+During RgGen installation, RgGen::SpreadsheetLoader will also be isntalled automatically.
+
+```
+$ gem install rggen
+```
+
+If you want to install RgGen::SpreadsheetLoader only, use the command below:
+
+```
+$ gem install rggen-spreadsheet-loader
+```
+
+## Contact
+
+Feedbacks, bug reports, questions and etc. are wellcome! You can post them by using following ways:
+
+* [GitHub Issue Tracker](https://github.com/rggen/rggen-spreadsheet-loader/issues)
+* [Mail](mailto:taichi730@gmail.com)
+
+## 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.
+
+## Code of Conduct
+
+Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rggen/rggen-spreadsheet-loader/blob/master/CODE_OF_CONDUCT.md).

data/lib/rggen/spreadsheet_loader/roo_loader.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    class RooLoader < Core::RegisterMap::Loader
+      include SpreadsheetLoader
+
+      support_types [:xlsx, :xls, :ods, :csv]
+
+      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))
+        end
+      end
+
+      private
+
+      def collect_cells(page)
+        (1..page.last_row).map do |row|
+          (1..page.last_column).map { |column| page.cell(row, column) }
+        end
+      end
+    end
+  end
+end

data/lib/rggen/spreadsheet_loader/spreadsheet/book.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    module Spreadsheet
+      class Book
+        def initialize(file)
+          @file = file
+          @sheets = []
+          block_given? && yield(self)
+        end
+
+        attr_reader :file
+        attr_reader :sheets
+
+        def add_sheet(sheet_name, table)
+          sheet = Sheet.new(self, sheet_name)
+          sheet.from_table(table)
+          sheets << sheet
+        end
+      end
+    end
+  end
+end

data/lib/rggen/spreadsheet_loader/spreadsheet/cell.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    module Spreadsheet
+      class Cell < Core::InputBase::InputValue
+        def initialize(row, column)
+          position = Position.new(row.file, row.sheet, row.row, column)
+          super(nil, position)
+        end
+
+        alias_method :empty_cell?, :empty_value?
+      end
+    end
+  end
+end

data/lib/rggen/spreadsheet_loader/spreadsheet/position.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    module Spreadsheet
+      Position = Struct.new(:file, :sheet, :row, :column) do
+        def to_s
+          to_h
+            .map { |field, value| "#{field}: #{value}" }
+            .join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/rggen/spreadsheet_loader/spreadsheet/row.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    module Spreadsheet
+      class Row
+        def initialize(sheet, row)
+          @file = sheet.file
+          @sheet = sheet.sheet
+          @row = row
+          @cells = []
+        end
+
+        attr_reader :file
+        attr_reader :sheet
+        attr_reader :row
+
+        def [](column)
+          @cells[column] ||= Cell.new(self, column)
+          @cells[column]
+        end
+
+        def []=(column, value)
+          self[column].value = value
+        end
+
+        def cells(from = 0, length = nil)
+          Array.new(length || (@cells.size - from)) { |i| self[from + i] }
+        end
+      end
+    end
+  end
+end

data/lib/rggen/spreadsheet_loader/spreadsheet/sheet.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    module Spreadsheet
+      class Sheet
+        def initialize(book, sheet)
+          @file = book.file
+          @sheet = sheet
+          @rows = []
+        end
+
+        attr_reader :file
+        attr_reader :sheet
+
+        def [](row, column = nil)
+          @rows[row] ||= Row.new(self, row)
+          (column && @rows[row][column]) || @rows[row]
+        end
+
+        def from_table(table)
+          table.each_with_index do |row, row_index|
+            row.each_with_index do |value, column_index|
+              self[row_index][column_index] = value
+            end
+          end
+        end
+
+        def rows(from = 0, length = nil)
+          Array.new(length || (@rows.size - from)) { |i| self[from + i] }
+        end
+      end
+    end
+  end
+end

data/lib/rggen/spreadsheet_loader/spreadsheet_loader.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    module SpreadsheetLoader
+      Position = Struct.new(:row, :column)
+
+      def read_file(file)
+        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) }
+      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
+      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|
+          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)
+      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
+      end
+
+      def register_cells(row)
+        start_column = register_start_position.column
+        size = register_valid_values.size
+        row.cells(start_column, size)
+      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
+      end
+
+      def bit_field_cells(row)
+        start_column = bit_field_start_position.column
+        size = bit_field_valid_values.size
+        row.cells(start_column, size)
+      end
+
+      def register_block_start_position
+        @register_block_start_position ||= Position.new(0, 2)
+      end
+
+      def register_start_position
+        @register_start_position ||=
+          Position.new(register_block_valid_values.size + 2, 1)
+      end
+
+      def bit_field_start_position
+        @bit_field_start_position ||=
+          begin
+            column =
+              register_start_position.column + register_valid_values.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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SpreadsheetLoader
+    VERSION = '0.9.0'
+  end
+end

data/lib/rggen/spreadsheet_loader.rb

@@ -0,0 +1,22 @@
+# 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'
+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/roo_loader'
+
+module RgGen
+  module SpreadsheetLoader
+    def self.setup(builder)
+      builder.register_loader(:register_map, RooLoader)
+    end
+  end
+
+  setup :'spreadsheet-loader', SpreadsheetLoader
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rggen-spreadsheet-loader
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Taichi Ishitani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: roo-xls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: Spreadsheet loader for RgGen register map.
+email:
+- taichi730@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/rggen/spreadsheet_loader.rb
+- lib/rggen/spreadsheet_loader/roo_loader.rb
+- lib/rggen/spreadsheet_loader/spreadsheet/book.rb
+- lib/rggen/spreadsheet_loader/spreadsheet/cell.rb
+- lib/rggen/spreadsheet_loader/spreadsheet/position.rb
+- lib/rggen/spreadsheet_loader/spreadsheet/row.rb
+- lib/rggen/spreadsheet_loader/spreadsheet/sheet.rb
+- lib/rggen/spreadsheet_loader/spreadsheet_loader.rb
+- lib/rggen/spreadsheet_loader/version.rb
+homepage: https://github.com/rggen/rggen-spreadsheet-loader
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/rggen/rggen-spreadsheet-loader/issues
+  source_code_uri: https://github.com/rggen/rggen-spreadsheet-loader
+  wiki_uri: https://github.com/rggen/rggen/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: rggen-spreadsheet-loader-0.9.0
+test_files: []