googlesheets 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 484ead7c7ddf83bd062e24d8edb28fb0da072cbbe348f598974c7dcc6fc81687
-  data.tar.gz: 224d0e6b86d115a4b9aff60faba79a174686f65f551dff9322bb8ff22d0445ce
+  metadata.gz: e6a26194973635e4ea51c7926c8cd03f900855b5c1776f517b0bbec78ac2b375
+  data.tar.gz: 801e67399e5c075742fe11913e6c9d996eb32f6fca24d7617fd4dfc17c2984e5
 SHA512:
-  metadata.gz: 38d00ab0cd8ac505238f604542e0f56f814d397cdf8d606c0a64cba8bf022afcd58173cf5af5e23cbf38590b18c49bc849001c231c23b509aee8b384a62b4580
-  data.tar.gz: a34dc14942dd9433331221804a95f940104a58b08c2830e1a6866c046db9b35c9ec220c91fd9c26aedc8b98b54a96274d007f045f0434c3db10fcf804543f670
+  metadata.gz: fd5432ce50b9d6528b444db90beda6d4b561b3b430fc8cac3a07dd3b4b3d8417f1fbdd84ff58ec18b19d8b3c520644febace35b3610b32e6c9a661abe615ec53
+  data.tar.gz: c2019272c6b2a079a33d1d6a831f2692ae6da0a195a46728a04524df742053e2691b3587ce01f3c01ef334fb44fe4314814950525c3f2bcdd3697f4b1dade097

data/lib/googlesheets.rb

@@ -1,30 +1,25 @@
+# ============================================================================
+# googlesheets - Ruby gem for Google Sheets
+#
+# Author: Steve Shreeve (steve.shreeve@gmail.com)
+#   Date: March 16, 2023
+# ============================================================================
+
+# See https://googleapis.dev/ruby/google-api-client/latest/Google/Apis/SheetsV4/Request.html
+
 require "google/apis/sheets_v4"
 require "googleauth"
 require "googleauth/stores/file_token_store"
 
-class Object
-  def blank?
-    respond_to?(:empty?) or return !self
-    empty? or respond_to?(:strip) && strip.empty?
-  end
-end
-
-module Enumerable
-  def first_result
-    block_given? ? each {|item| result = (yield item) and return result} && nil : find {|item| item}
-  end
-end
-
-# https://googleapis.dev/ruby/google-api-client/latest/Google/Apis/SheetsV4/Request.html
-
 class GoogleSheets
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 
   attr_accessor :api
 
   def initialize(ssid, **opts)
     @ssid = ssid =~ /^https?:/ ? ssid.split("/")[5] : ssid # spreadsheet id
-    @wsid = ssid[/(?<=#gid=)(\d+)$/] && $1.to_i # default worksheet id
+    @wsid = ssid =~ /(?<=#gid=)(\d+)(?:!([a-z\d:]+))?$/i ? $1.to_i : "#1" # worksheet id
+    @rect = $2 ? $2.sub(/(?<=\D):/, "1:") : "A:ZZ"
 
     @json = opts[:credentials] || "credentials.json"
     @yaml = opts[:token      ] || "token.yaml"
@@ -54,12 +49,15 @@ class GoogleSheets
     end
   end
 
-  def rgb2hex(color=nil)
-    color or return
-    r = ((color.red   || 0) * 255).to_i
-    g = ((color.green || 0) * 255).to_i
-    b = ((color.blue  || 0) * 255).to_i
-    "#%02x%02x%02x" % [r, g, b]
+  def biject(x) # a=1, z=26, aa=27, az=52, ba=53, aaa=703
+    case x
+    when String
+      x.each_char.inject(0) {|n,c| (n * 26) + (c.ord & 31) }
+    when Integer
+      s = []
+      s << (((x -= 1) % 26) + 65).chr && x /= 26 while x > 0
+      s.reverse.join
+    end
   end
 
   def hex2rgb(color=nil)
@@ -71,15 +69,12 @@ class GoogleSheets
     { red: r, green: g, blue: b }
   end
 
-  def biject(x) # a=1, z=26, aa=27, az=52, ba=53, aaa=703
-    case x
-    when String
-      x.each_char.inject(0) {|n,c| (n * 26) + (c.ord & 31) }
-    when Integer
-      s = []
-      s << (((x -= 1) % 26) + 65).chr && x /= 26 while x > 0
-      s.reverse.join
-    end
+  def rgb2hex(color=nil)
+    color or return
+    r = ((color.red   || 0) * 255).to_i
+    g = ((color.green || 0) * 255).to_i
+    b = ((color.blue  || 0) * 255).to_i
+    "#%02x%02x%02x" % [r, g, b]
   end
 
   def filter_criteria(hash)
@@ -109,6 +104,8 @@ class GoogleSheets
     }.compact
   end
 
+  # --------------------------------------------------------------------------
+
   def sheets
     @sheets ||= api.get_spreadsheet(@ssid).sheets.map {|item| item.properties }
   end
@@ -118,33 +115,6 @@ class GoogleSheets
     sheets
   end
 
-  def sheet_list
-    sheets.map do |item|
-      {
-        id:    item.sheet_id,
-        name:  item.title,
-        color: rgb2hex(item.tab_color),
-      }.compact
-    end
-  end
-
-  def sheet_id(obj)
-    case obj
-      when /^#(\d+)$/ then sheets[$1.to_i - 1].sheet_id
-      when Integer    then obj
-      else sheets.first_result {|item| item.sheet_id if item.title == obj}
-    end
-  end
-
-  def sheet_name(obj=nil)
-    case obj ||= @wsid || "#1"
-      when /^#(\d+)$/ then sheets[$1.to_i - 1].title
-      when Integer    then sheets.first_result {|item| item.title if item.sheet_id == obj }
-      when "", nil     then sheets.first.title
-      else obj
-    end
-  end
-
   def resolve_area(area)
     if area.blank?
       wsid = sheet_name
@@ -157,30 +127,29 @@ class GoogleSheets
     else
       wsid = sheet_name(area)
     end
-    "#{wsid}!#{rect || 'A:ZZ'}"
+    rect = rect ? rect.sub(/(?<=\D):/, "1:") : @rect
+    "#{wsid}!#{rect}"
   end
 
-  def sheet_rename(pick, name=nil)
-    shid = sheet_id(pick)
-    name ||= yield(sheet_name(shid)) if block_given?
+  def sheet_name(obj=nil)
+    case obj ||= @wsid
+      when /^#(\d+)(?:!?|$)/ then sheets[$1.to_i - 1].title
+      when "", 0, nil        then sheets.first.title
+      when Integer           then sheets.find {|item| item.sheet_id == obj}&.title
+      else obj
+    end
+  end
 
-    reqs = []
-    reqs.push(update_sheet_properties: {
-      properties: {
-        sheet_id: shid,
-        title: name,
-      },
-      fields: "title",
-    })
-    resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
-    true
+  def sheet_clear(area)
+    area = resolve_area(area)
+    api.clear_values(@ssid, area)
   end
 
-  def sheet_color(pick, color=nil) # NOTE: ignores alpha
+  def sheet_color(curr, color=nil) # NOTE: ignores alpha
     reqs = []
     reqs.push(update_sheet_properties: {
       properties: {
-        sheet_id: sheet_id(pick),
+        sheet_id: sheet_id(curr),
         tab_color: hex2rgb(color),
       },
       fields: "tab_color",
@@ -189,10 +158,10 @@ class GoogleSheets
     true
   end
 
-  def sheet_filter(area, want=nil)
+  def sheet_filter(area, filt=nil)
     area = resolve_area(area)
     range = range(area)
-    criteria = filter_criteria(want) if want
+    criteria = filter_criteria(filt) if filt
     reqs = []
     reqs.push(clear_basic_filter: { sheet_id: range[:sheet_id] })
     reqs.push(set_basic_filter: { filter: { range: range, criteria: criteria}.compact })
@@ -219,9 +188,38 @@ class GoogleSheets
     true
   end
 
-  def sheet_clear(area)
-    area = resolve_area(area)
-    api.clear_values(@ssid, area)
+  def sheet_id(obj)
+    case obj
+      when /^#(\d+)(?:!?|$)/ then sheets[$1.to_i - 1].sheet_id
+      when Integer           then obj
+      else sheets.find {|item| item.title == obj}&.sheet_id
+    end
+  end
+
+  def sheet_list
+    sheets.map do |item|
+      {
+        id:    item.sheet_id,
+        name:  item.title,
+        color: rgb2hex(item.tab_color),
+      }.compact
+    end
+  end
+
+  def sheet_rename(curr, name=nil)
+    shid = sheet_id(curr)
+    name ||= yield(sheet_name(shid)) if block_given?
+
+    reqs = []
+    reqs.push(update_sheet_properties: {
+      properties: {
+        sheet_id: shid,
+        title: name,
+      },
+      fields: "title",
+    })
+    resp = api.batch_update_spreadsheet(@ssid, { requests: reqs }, {})
+    true
   end
 
   def sheet_read(area=nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: googlesheets
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Steve Shreeve
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client