google-docs-table-factory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88ae7c8d217f19605a42423877d880af1d2326b6ce9331c149cd5fe24e2ecfd7
+  data.tar.gz: 924126d5b1044b889d7120212262896f970cbaceede042e87ba28e5c93612436
+SHA512:
+  metadata.gz: 17b8de56b4e5a501aa8130d356a4b6a659d9a89b68007080c06eb99b1e09151c2474626618dab442fb20ff02f97b35d7cf53be0ff71fcb16f0dafaa5c65d851a
+  data.tar.gz: efe63bed09c190e618cfdc54484c82778a24dff330ce5acff88599f5c7e69e6de23d81ce8f798d6cb4de745f7df5c51a6b8622a57ee2965169edab46a6177cab

data/.gitignore

@@ -0,0 +1 @@
+/Gemfile.lock

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 gustavo@matias.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/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in google-docs-table.gemspec
+gemspec
+
+gem "minitest-reporters", "~> 1.4", group: :test
+
+gem "pry", "~> 0.12.2", group: :test

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Gustavo Matias
+
+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,107 @@
+<p align="left">
+  <img width="370" src="https://user-images.githubusercontent.com/681278/71585040-1f6c9380-2b0d-11ea-90f4-68f03d37685a.jpg">
+</p>
+
+# Description
+
+The purpose of this library is to provide simpler ways for manipulating table and its contents in Google Docs.
+
+This solve for the difficulty myself and [a few others](https://github.com/tanaikech/node-gdoctableapp) had when attempting to manage tables on Google Docs using the Google Docs V1 API. 
+
+## Features
+
+- Create table with values in rows and columns
+
+## Some Missing Features
+
+- Read table values
+- Update table values
+- Delete tables, rows and columns
+
+## Language Support
+
+There are more fleshed out libraries in other languages that I found helpful when researching prior to deciding to build the first piece of the puzzle for Ruby.
+
+- [go-gdoctableapp](https://github.com/tanaikech/go-gdoctableapp)
+- [node-gdoctableapp](https://github.com/tanaikech/node-gdoctableapp)
+- [gdoctableapppy](https://github.com/tanaikech/gdoctableapppy)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google-docs-table-factory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-docs-table-factory
+
+## Usage
+
+### Create table with values in rows and columns
+
+```
+requests = ::Google::Api::DocsV1::TableFactory.insert_table_request(
+  index: 1,
+  table_data: [
+    ['A1', 'B1', 'C1'],
+    [nil,  'B2',  nil],
+    ['A3', 'B3', 'C3']
+  ]
+)
+```
+
+Will result in a structure GDocs V1 API can digest:
+```
+# => requests
+[
+  {:insert_table=>{:columns=>3, :rows=>3, :location=>{:index=>1}}}
+  {:insert_text=>{:location=>{:index=>23}, :text=>"C3"}}
+  {:insert_text=>{:location=>{:index=>21}, :text=>"B3"}}
+  {:insert_text=>{:location=>{:index=>19}, :text=>"A3"}}
+  {:insert_text=>{:location=>{:index=>14}, :text=>"B2"}}
+  {:insert_text=>{:location=>{:index=>9}, :text=>"C1"}}
+  {:insert_text=>{:location=>{:index=>7}, :text=>"B1"}}
+  {:insert_text=>{:location=>{:index=>5}, :text=>"A1"}}
+]
+```
+
+And look like:
+![](https://user-images.githubusercontent.com/681278/71565771-e0f1bd00-2aa9-11ea-963e-2f48733a8222.jpg)
+
+A full example could be:
+
+```
+require 'google/apis/docs_v1'
+require 'googleauth'
+
+# Service Account authorization or whatever else you prefer
+gdocs = ::Google::Apis::DocsV1::DocsService.new
+gdoc_auth = ::Google::Auth::ServiceAccountCredentials.make_creds(scope: 'https://www.googleapis.com/auth/documents')
+gdocs.authorization = gdoc_auth
+
+# POST updates to Google Docs
+file_id = 'ABC123-GoogleDocumentId-Here'
+batch_request = Google::Apis::DocsV1::BatchUpdateDocumentRequest.new(requests: requests)
+gdocs.batch_update_document(file_id, batch_request)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gumatias/google-docs-table-factory. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Google::Api::DocsV1::TableFactory project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gumatias/google-docs-table-factory/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google/api/docs_v1/table_factory"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/google-docs-table-factory.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "google/api/docs_v1/table_factory/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "google-docs-table-factory"
+  spec.version       = Google::Api::DocsV1::TableFactory::VERSION
+  spec.authors       = ["Gustavo Matias"]
+  spec.email         = ["gustavo@matias.love"]
+
+  spec.summary       = "Ruby library for managing tables on Google Documents using the Google API"
+  spec.description   = %q{
+    The purpose of this library is to provide simpler ways for manipulating table and its contents in Google Docs.
+
+    This solve for the difficulty myself and a few others had when attempting to manage tables on Google Docs using the Google Docs V1 API.
+  }
+  spec.homepage      = "https://github.com/gumatias/google-docs-table-factory"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/gumatias/google-docs-table-factory"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/google/api/docs_v1/table_factory.rb

@@ -0,0 +1,69 @@
+require "google/api/docs_v1/table_factory/version"
+
+module Google
+  module Api
+    module DocsV1
+      module TableFactory
+        class Error < StandardError; end
+
+        TABLE_CONTENT_INDEX = 4
+        TABLE_COLUMN_GUTTER = 2
+        TABLE_ROW_GUTTER = 1
+
+        def self.insert_table_request(table_data:, index:)
+          max_row = table_data.size
+          max_col = table_data.max_by(&:size).size
+
+          [
+            {
+              insert_table: {
+                columns: max_col,
+                rows: max_row,
+                location: {
+                  index: index,
+                },
+              },
+            },
+          ] + request_for_insert_text(
+            table_data: table_data,
+            index: index,
+            max_row: max_row,
+            max_col: max_col,
+          )
+        end
+
+        def self.request_for_insert_text(table_data:, index:, max_row:, max_col:)
+          input_values = parse_input_values(
+            table_data: table_data,
+            index: index,
+            max_row: max_row,
+            max_col: max_col,
+          )
+
+          input_values.reverse.map do |value|
+            if !value[:content].nil?
+              { insert_text: { location: { index: value[:index] }, text: value[:content] } }
+            end
+          end.compact
+        end
+
+        def self.parse_input_values(table_data:, index:, max_row:, max_col:)
+          index += TABLE_CONTENT_INDEX
+          v = []
+          (0..(max_row - 1)).each do |row|
+            (0..(max_col - 1)).each do |col|
+              if max_row > row && max_col > col && !table_data[row][col].nil?
+                v.push(row: row, col: col, content: table_data[row][col], index: index)
+              end
+              index += TABLE_COLUMN_GUTTER
+            end
+
+            index += TABLE_ROW_GUTTER
+          end
+
+          v
+        end
+      end
+    end
+  end
+end

data/lib/google/api/docs_v1/table_factory/version.rb

@@ -0,0 +1,9 @@
+module Google
+  module Api
+    module DocsV1
+      module TableFactory
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: google-docs-table-factory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gustavo Matias
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: "\n    The purpose of this library is to provide simpler ways for manipulating
+  table and its contents in Google Docs.\n\n    This solve for the difficulty myself
+  and a few others had when attempting to manage tables on Google Docs using the Google
+  Docs V1 API.\n  "
+email:
+- gustavo@matias.love
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google-docs-table-factory.gemspec
+- lib/google/api/docs_v1/table_factory.rb
+- lib/google/api/docs_v1/table_factory/version.rb
+homepage: https://github.com/gumatias/google-docs-table-factory
+licenses: []
+metadata:
+  homepage_uri: https://github.com/gumatias/google-docs-table-factory
+  source_code_uri: https://github.com/gumatias/google-docs-table-factory
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.10
+signing_key: 
+specification_version: 4
+summary: Ruby library for managing tables on Google Documents using the Google API
+test_files: []