google_drive 2.1.8 → 2.1.9

data/lib/google_drive/spreadsheet.rb

@@ -12,12 +12,13 @@ require 'google_drive/file'
 module GoogleDrive
   # A spreadsheet.
   #
-  # e.g., Use methods spreadsheet_by_title, spreadsheet_by_url, create_spreadsheet in GoogleDrive::Session
-  # to get GoogleDrive::Spreadsheet object.
+  # e.g., Use methods spreadsheet_by_title, spreadsheet_by_url,
+  # create_spreadsheet in GoogleDrive::Session to get GoogleDrive::Spreadsheet
+  # object.
   class Spreadsheet < GoogleDrive::File
     include(Util)
 
-    SUPPORTED_EXPORT_FORMAT = Set.new(%w(xlsx csv pdf))
+    SUPPORTED_EXPORT_FORMAT = Set.new(%w[xlsx csv pdf])
 
     # Key of the spreadsheet.
     def key
@@ -26,13 +27,15 @@ module GoogleDrive
 
     # URL of worksheet-based feed of the spreadsheet.
     def worksheets_feed_url
-      'https://spreadsheets.google.com/feeds/worksheets/%s/private/full' %
-        id
+      format(
+        'https://spreadsheets.google.com/feeds/worksheets/%s/private/full', id
+      )
     end
 
     # URL of feed used in the deprecated document list feed API.
     def document_feed_url
-      'https://docs.google.com/feeds/documents/private/full/' + CGI.escape(resource_id)
+      'https://docs.google.com/feeds/documents/private/full/' +
+        CGI.escape(resource_id)
     end
 
     # Spreadsheet feed URL of the spreadsheet.
@@ -44,17 +47,20 @@ module GoogleDrive
     def worksheets
       doc = @session.request(:get, worksheets_feed_url)
       if doc.root.name != 'feed'
-        fail(GoogleDrive::Error,
-             "%s doesn't look like a worksheets feed URL because its root is not <feed>." %
-             worksheets_feed_url)
+        raise(GoogleDrive::Error,
+              format(
+                "%s doesn't look like a worksheets feed URL because its root " \
+                'is not <feed>.',
+                worksheets_feed_url
+              ))
       end
       doc.css('entry').map { |e| Worksheet.new(@session, self, e) }.freeze
     end
 
     # Returns a GoogleDrive::Worksheet with the given title in the spreadsheet.
     #
-    # Returns nil if not found. Returns the first one when multiple worksheets with the
-    # title are found.
+    # Returns nil if not found. Returns the first one when multiple worksheets
+    # with the title are found.
     def worksheet_by_title(title)
       worksheets.find { |ws| ws.title == title }
     end
@@ -67,7 +73,8 @@ module GoogleDrive
       worksheets.find { |ws| ws.gid == gid }
     end
 
-    # Adds a new worksheet to the spreadsheet. Returns added GoogleDrive::Worksheet.
+    # Adds a new worksheet to the spreadsheet. Returns added
+    # GoogleDrive::Worksheet.
     def add_worksheet(title, max_rows = 100, max_cols = 20)
       xml = <<-"EOS"
             <entry xmlns='http://www.w3.org/2005/Atom'
@@ -82,27 +89,30 @@ module GoogleDrive
     end
 
     # Not available for GoogleDrive::Spreadsheet. Use export_as_file instead.
-    def download_to_file(path, params = {})
+    def download_to_file(_path, _params = {})
       raise(
-          NotImplementedError,
-          "download_to_file is not available for GoogleDrive::Spreadsheet. " +
-          "Use export_as_file instead.")
+        NotImplementedError,
+        'download_to_file is not available for GoogleDrive::Spreadsheet. ' \
+        'Use export_as_file instead.'
+      )
     end
 
     # Not available for GoogleDrive::Spreadsheet. Use export_as_string instead.
-    def download_to_string(params = {})
+    def download_to_string(_params = {})
       raise(
-          NotImplementedError,
-          "download_to_string is not available for GoogleDrive::Spreadsheet. " +
-          "Use export_as_string instead.")
+        NotImplementedError,
+        'download_to_string is not available for GoogleDrive::Spreadsheet. ' \
+        'Use export_as_string instead.'
+      )
     end
 
     # Not available for GoogleDrive::Spreadsheet. Use export_to_io instead.
-    def download_to_io(io, params = {})
+    def download_to_io(_io, _params = {})
       raise(
-          NotImplementedError,
-          "download_to_io is not available for GoogleDrive::Spreadsheet. " +
-          "Use export_to_io instead.")
+        NotImplementedError,
+        'download_to_io is not available for GoogleDrive::Spreadsheet. ' \
+        'Use export_to_io instead.'
+      )
     end
   end
 end

data/lib/google_drive/util.rb

@@ -28,7 +28,7 @@ module GoogleDrive
       '.html' => 'text/html',
       '.zip' => 'application/zip',
       '.swf' => 'application/x-shockwave-flash'
-    }
+    }.freeze
 
     IMPORTABLE_CONTENT_TYPE_MAP = {
       'application/x-vnd.oasis.opendocument.presentation' => 'application/vnd.google-apps.presentation',
@@ -74,19 +74,22 @@ module GoogleDrive
       'text/csv' => 'application/vnd.google-apps.spreadsheet',
       'application/vnd.oasis.opendocument.presentation' => 'application/vnd.google-apps.presentation',
       'image/jpg' => 'application/vnd.google-apps.document',
-      'text/richtext' => 'application/vnd.google-apps.document',
-    }
+      'text/richtext' => 'application/vnd.google-apps.document'
+    }.freeze
 
     module_function
 
     def encode_query(params)
-      params.map { |k, v| CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s) }.join('&')
+      params
+        .map { |k, v| CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s) }
+        .join('&')
     end
 
     def concat_url(url, piece)
       (url_base, url_query) = url.split(/\?/, 2)
       (piece_base, piece_query) = piece.split(/\?/, 2)
-      result_query = [url_query, piece_query].select { |s| s && !s.empty? }.join('&')
+      result_query =
+        [url_query, piece_query].select { |s| s && !s.empty? }.join('&')
       (url_base || '') +
         (piece_base || '') +
         (result_query.empty? ? '' : "?#{result_query}")
@@ -101,40 +104,52 @@ module GoogleDrive
       case arg
 
       when String
-        return arg
+        arg
 
       when Array
         if arg[0].scan(/\?/).size != arg.size - 1
-          fail(
+          raise(
             ArgumentError,
-            "The number of placeholders doesn't match the number of arguments: %p" % [arg])
+            format(
+              "The number of placeholders doesn't match the number of " \
+              'arguments: %p',
+              arg
+            )
+          )
         end
         i = 1
-        return arg[0].gsub(/\?/) do
+        arg[0].gsub(/\?/) do
           v = arg[i]
           i += 1
           case v
           when String
-            "'%s'" % v.gsub(/['\\]/) { '\\' + $& }
+            format("'%s'", v.gsub(/['\\]/) { '\\' + $& })
           when Time
-            "'%s'" % v.iso8601
+            format("'%s'", v.iso8601)
           when TrueClass
             'true'
           when FalseClass
             'false'
           else
-            fail(ArgumentError, 'Expected String, Time, true or false, but got %p' % [v])
+            raise(
+              ArgumentError,
+              format('Expected String, Time, true or false, but got %p', v)
+            )
           end
         end
 
       else
-        fail(ArgumentError, 'Expected String or Array, but got %p' % [arg])
+        raise(
+          ArgumentError, format('Expected String or Array, but got %p', arg)
+        )
 
       end
     end
 
     def construct_and_query(args)
-      args.select { |a| a }.map { |a| '(%s)' % construct_query(a) }.join(' and ')
+      args
+        .select { |a| a }.map { |a| format('(%s)', construct_query(a)) }
+        .join(' and ')
     end
 
     def convert_params(params)
@@ -180,21 +195,26 @@ module GoogleDrive
         when 'showdeleted'
           old_terms.push('trashed = false') if v.to_s == 'false'
         when 'ocr', 'targetLanguage', 'sourceLanguage'
-          fail(ArgumentError, "'%s' parameter is no longer supported." % k)
+          raise(
+            ArgumentError, format("'%s' parameter is no longer supported.", k)
+          )
         else
           # e.g., 'pageToken' -> :page_token
-          new_key = k.
-              gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-              gsub(/([a-z\d])([A-Z])/,'\1_\2').
-              downcase.
-              intern
+          new_key = k
+                    .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                    .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                    .downcase
+                    .intern
           new_params[new_key] = v
         end
       end
 
       unless old_terms.empty?
         if new_params.key?(:q)
-          fail(ArgumentError, "Cannot specify both 'q' parameter and old query parameters.")
+          raise(
+            ArgumentError,
+            "Cannot specify both 'q' parameter and old query parameters."
+          )
         else
           new_params[:q] = construct_and_query(old_terms)
         end
@@ -213,10 +233,9 @@ module GoogleDrive
       sc = get_singleton_class(obj)
       names = api_obj.public_methods(false) - exceptions
       names.each do |name|
-        if !(name.to_s =~ /=$/)
-          sc.__send__(:define_method, name) do
-            api_obj.__send__(name)
-          end
+        next if name.to_s =~ /=$/
+        sc.__send__(:define_method, name) do
+          api_obj.__send__(name)
         end
       end
     end

data/lib/google_drive/worksheet.rb

@@ -11,7 +11,8 @@ require 'google_drive/list'
 
 module GoogleDrive
   # A worksheet (i.e. a tab) in a spreadsheet.
-  # Use GoogleDrive::Spreadsheet#worksheets to get GoogleDrive::Worksheet object.
+  # Use GoogleDrive::Spreadsheet#worksheets to get GoogleDrive::Worksheet
+  # object.
   class Worksheet
     include(Util)
 
@@ -19,7 +20,7 @@ module GoogleDrive
     # A regexp which matches an invalid character in XML 1.0:
     # https://en.wikipedia.org/wiki/Valid_characters_in_XML#XML_1.0
     XML_INVAILD_CHAR_REGEXP =
-        /[^\u0009\u000a\u000d\u0020-\ud7ff\ue000-\ufffd\u{10000}-\u{10ffff}]/
+      /[^\u0009\u000a\u000d\u0020-\ud7ff\ue000-\ufffd\u{10000}-\u{10ffff}]/
 
     # @api private
     def initialize(session, spreadsheet, worksheet_feed_entry)
@@ -46,7 +47,8 @@ module GoogleDrive
     # URL of cell-based feed of the worksheet.
     def cells_feed_url
       @worksheet_feed_entry.css(
-        "link[rel='http://schemas.google.com/spreadsheets/2006#cellsfeed']")[0]['href']
+        "link[rel='http://schemas.google.com/spreadsheets/2006#cellsfeed']"
+      )[0]['href']
     end
 
     # URL of worksheet feed URL of the worksheet.
@@ -57,7 +59,8 @@ module GoogleDrive
     # URL to export the worksheet as CSV.
     def csv_export_url
       @worksheet_feed_entry.css(
-        "link[rel='http://schemas.google.com/spreadsheets/2006#exportcsv']")[0]['href']
+        "link[rel='http://schemas.google.com/spreadsheets/2006#exportcsv']"
+      )[0]['href']
     end
 
     # Exports the worksheet as String in CSV format.
@@ -79,15 +82,17 @@ module GoogleDrive
 
     # URL to view/edit the worksheet in a Web browser.
     def human_url
-      "%s\#gid=%s" % [spreadsheet.human_url, gid]
+      format("%s\#gid=%s", spreadsheet.human_url, gid)
     end
 
     # GoogleDrive::Spreadsheet which this worksheet belongs to.
     def spreadsheet
       unless @spreadsheet
-        unless worksheet_feed_url =~ %r{https?://spreadsheets\.google\.com/feeds/worksheets/(.*)/(.*)$}
-          fail(GoogleDrive::Error,
-               "Worksheet feed URL is in unknown format: #{worksheet_feed_url}")
+        unless worksheet_feed_url =~
+               %r{https?://spreadsheets\.google\.com/feeds/worksheets/(.*)/(.*)$}
+          raise(GoogleDrive::Error,
+                'Worksheet feed URL is in unknown format: ' \
+                "#{worksheet_feed_url}")
         end
         @spreadsheet = @session.file_by_id(Regexp.last_match(1))
       end
@@ -106,8 +111,9 @@ module GoogleDrive
     end
 
     # Updates content of the cell.
-    # Arguments in the bracket must be either (row number, column number) or cell name.
-    # Note that update is not sent to the server until you call save().
+    # Arguments in the bracket must be either (row number, column number) or
+    # cell name. Note that update is not sent to the server until you call
+    # save().
     # Top-left cell is [1, 1].
     #
     # e.g.
@@ -163,12 +169,15 @@ module GoogleDrive
     # (row number, column number) or cell name. Top-left cell is [1, 1].
     #
     # e.g.
-    #   worksheet[1, 3]                #=> "3,0" # it depends on locale, currency...
-    #   worksheet.numeric_value(1, 3)  #=> 3.0
+    #   worksheet[1, 3]
+    #   #=> "3,0"  # it depends on locale, currency...
+    #   worksheet.numeric_value(1, 3)
+    #   #=> 3.0
     #
     # Returns nil if the cell is empty or contains non-number.
     #
-    # If you modify the cell, its numeric_value is nil until you call save() and reload().
+    # If you modify the cell, its numeric_value is nil until you call save()
+    # and reload().
     #
     # For details, see:
     # https://developers.google.com/google-apps/spreadsheets/#working_with_cell-based_feeds
@@ -183,7 +192,12 @@ module GoogleDrive
       reload_cells unless @cells
       # Memoizes it because this can be bottle-neck.
       # https://github.com/gimite/google-drive-ruby/pull/49
-      @num_rows ||= @input_values.select { |(_r, _c), v| !v.empty? }.map { |(r, _c), _v| r }.max || 0
+      @num_rows ||=
+        @input_values
+        .reject { |(_r, _c), v| v.empty? }
+        .map { |(r, _c), _v| r }
+        .max ||
+        0
     end
 
     # Column number of the right-most non-empty column.
@@ -191,7 +205,12 @@ module GoogleDrive
       reload_cells unless @cells
       # Memoizes it because this can be bottle-neck.
       # https://github.com/gimite/google-drive-ruby/pull/49
-      @num_cols ||= @input_values.select { |(_r, _c), v| !v.empty? }.map { |(_r, c), _v| c }.max || 0
+      @num_cols ||=
+        @input_values
+        .reject { |(_r, _c), v| v.empty? }
+        .map { |(_r, c), _v| c }
+        .max ||
+        0
     end
 
     # Number of rows including empty rows.
@@ -257,7 +276,7 @@ module GoogleDrive
       self.max_rows += rows.size
       num_rows.downto(row_num) do |r|
         (1..num_cols).each do |c|
-          self[r + rows.size, c] = self.input_value(r, c)
+          self[r + rows.size, c] = input_value(r, c)
         end
       end
 
@@ -281,18 +300,19 @@ module GoogleDrive
     # worksheet contains inter-cell reference.
     def delete_rows(row_num, rows)
       if row_num + rows - 1 > self.max_rows
-        fail(ArgumentError, 'The row number is out of range')
+        raise(ArgumentError, 'The row number is out of range')
       end
       for r in row_num..(self.max_rows - rows)
         for c in 1..num_cols
-          self[r, c] = self.input_value(r + rows, c)
+          self[r, c] = input_value(r + rows, c)
         end
       end
       self.max_rows -= rows
     end
 
     # Reloads content of the worksheets from the server.
-    # Note that changes you made by []= etc. is discarded if you haven't called save().
+    # Note that changes you made by []= etc. is discarded if you haven't called
+    # save().
     def reload
       set_worksheet_feed_entry(@session.request(:get, worksheet_feed_url).root)
       reload_cells
@@ -316,24 +336,30 @@ module GoogleDrive
             EOS
 
         result = @session.request(
-          :put, edit_url, data: xml,
-                          header: { 'Content-Type' => 'application/atom+xml;charset=utf-8', 'If-Match' => '*' })
+          :put,
+          edit_url,
+          data: xml,
+          header: {
+            'Content-Type' => 'application/atom+xml;charset=utf-8',
+            'If-Match' => '*'
+          }
+        )
         set_worksheet_feed_entry(result.root)
 
         sent = true
-
       end
 
       unless @modified.empty?
-
         # Gets id and edit URL for each cell.
         # Note that return-empty=true is required to get those info for empty cells.
         cell_entries = {}
         rows = @modified.map { |r, _c| r }
         cols = @modified.map { |_r, c| c }
-        url = concat_url(cells_feed_url,
-                         "?return-empty=true&min-row=#{rows.min}&max-row=#{rows.max}" \
-                         "&min-col=#{cols.min}&max-col=#{cols.max}")
+        url = concat_url(
+          cells_feed_url,
+          "?return-empty=true&min-row=#{rows.min}&max-row=#{rows.max}" \
+          "&min-col=#{cols.min}&max-col=#{cols.max}"
+        )
         doc = @session.request(:get, url)
 
         doc.css('entry').each do |entry|
@@ -354,8 +380,13 @@ module GoogleDrive
           id        = entry.css('id').text
           edit_link = entry.css("link[rel='edit']")[0]
           unless edit_link
-            fail(GoogleDrive::Error,
-                 "The user doesn't have write permission to the spreadsheet: %p" % spreadsheet)
+            raise(
+              GoogleDrive::Error,
+              format(
+                "The user doesn't have write permission to the spreadsheet: %p",
+                spreadsheet
+              )
+            )
           end
           edit_url = edit_link['href']
           xml << <<-EOS
@@ -363,9 +394,14 @@ module GoogleDrive
                   <batch:id>#{h(row)},#{h(col)}</batch:id>
                   <batch:operation type="update"/>
                   <id>#{h(id)}</id>
-                  <link rel="edit" type="application/atom+xml"
+                  <link
+                    rel="edit"
+                    type="application/atom+xml"
                     href="#{h(edit_url)}"/>
-                  <gs:cell row="#{h(row)}" col="#{h(col)}" inputValue="#{h(value)}"/>
+                  <gs:cell
+                    row="#{h(row)}"
+                    col="#{h(col)}"
+                    inputValue="#{h(value)}"/>
                 </entry>
           EOS
         end
@@ -378,17 +414,27 @@ module GoogleDrive
           :post,
           batch_url,
           data: xml,
-          header: { 'Content-Type' => 'application/atom+xml;charset=utf-8', 'If-Match' => '*' })
+          header: {
+            'Content-Type' => 'application/atom+xml;charset=utf-8',
+            'If-Match' => '*'
+          }
+        )
         result.css('entry').each do |entry|
           interrupted = entry.css('batch|interrupted')[0]
           if interrupted
-            fail(GoogleDrive::Error, 'Update has failed: %s' %
-                                     interrupted['reason'])
-          end
-          unless entry.css('batch|status').first['code'] =~ /^2/
-            fail(GoogleDrive::Error, 'Updating cell %s has failed: %s' %
-                                     [entry.css('id').text, entry.css('batch|status')[0]['reason']])
+            raise(
+              GoogleDrive::Error,
+              format('Update has failed: %s', interrupted['reason'])
+            )
           end
+          next if entry.css('batch|status').first['code'] =~ /^2/
+          raise(
+            GoogleDrive::Error,
+            format(
+              'Updating cell %s has failed: %s',
+              entry.css('id').text, entry.css('batch|status')[0]['reason']
+            )
+          )
         end
 
         @modified.clear
@@ -405,7 +451,8 @@ module GoogleDrive
       reload
     end
 
-    # Deletes this worksheet. Deletion takes effect right away without calling save().
+    # Deletes this worksheet. Deletion takes effect right away without calling
+    # save().
     def delete
       ws_doc = @session.request(:get, worksheet_feed_url)
       edit_url = ws_doc.css("link[rel='edit']")[0]['href']
@@ -420,10 +467,12 @@ module GoogleDrive
     # List feed URL of the worksheet.
     def list_feed_url
       @worksheet_feed_entry.css(
-        "link[rel='http://schemas.google.com/spreadsheets/2006#listfeed']")[0]['href']
+        "link[rel='http://schemas.google.com/spreadsheets/2006#listfeed']"
+      )[0]['href']
     end
 
-    # Provides access to cells using column names, assuming the first row contains column
+    # Provides access to cells using column names, assuming the first row
+    # contains column
     # names. Returned object is GoogleDrive::List which you can use mostly as
     # Array of Hash.
     #
@@ -444,12 +493,19 @@ module GoogleDrive
     #   worksheet.cell_name_to_row_col("C2")  #=> [2, 3]
     def cell_name_to_row_col(cell_name)
       unless cell_name.is_a?(String)
-        fail(ArgumentError, 'Cell name must be a string: %p' % cell_name)
+        raise(
+          ArgumentError, format('Cell name must be a string: %p', cell_name)
+        )
       end
       unless cell_name.upcase =~ /^([A-Z]+)(\d+)$/
-        fail(ArgumentError,
-             'Cell name must be only letters followed by digits with no spaces in between: %p' %
-                 cell_name)
+        raise(
+          ArgumentError,
+          format(
+            'Cell name must be only letters followed by digits with no ' \
+            'spaces in between: %p',
+            cell_name
+          )
+        )
       end
       col = 0
       Regexp.last_match(1).each_byte do |b|
@@ -463,7 +519,11 @@ module GoogleDrive
     def inspect
       fields = { worksheet_feed_url: worksheet_feed_url }
       fields[:title] = @title if @title
-      "\#<%p %s>" % [self.class, fields.map { |k, v| '%s=%p' % [k, v] }.join(', ')]
+      format(
+        "\#<%p %s>",
+        self.class,
+        fields.map { |k, v| format('%s=%p', k, v) }.join(', ')
+      )
     end
 
     private
@@ -475,7 +535,7 @@ module GoogleDrive
       @updated = Time.parse(entry.css('updated').text)
       @meta_modified = false
     end
-    
+
     def set_max_values(entry)
       @max_rows = entry.css('gs|rowCount').text.to_i
       @max_cols = entry.css('gs|colCount').text.to_i
@@ -504,23 +564,36 @@ module GoogleDrive
 
     def parse_cell_args(args)
       if args.size == 1 && args[0].is_a?(String)
-        return cell_name_to_row_col(args[0])
+        cell_name_to_row_col(args[0])
       elsif args.size == 2 && args[0].is_a?(Integer) && args[1].is_a?(Integer)
         if args[0] >= 1 && args[1] >= 1
-          return args
+          args
         else
-          fail(ArgumentError,
-               'Row/col must be >= 1 (1-origin), but are %d/%d' % [args[0], args[1]])
+          raise(
+            ArgumentError,
+            format(
+              'Row/col must be >= 1 (1-origin), but are %d/%d',
+              args[0], args[1]
+            )
+          )
         end
       else
-        fail(ArgumentError,
-             "Arguments must be either one String or two Integer's, but are %p" % [args])
+        raise(
+          ArgumentError,
+          format(
+            "Arguments must be either one String or two Integer's, but are %p",
+            args
+          )
+        )
       end
     end
 
     def validate_cell_value(value)
       if value =~ XML_INVAILD_CHAR_REGEXP
-        fail(ArgumentError, 'Contains invalid character %p for XML 1.0: %p' % [$&, value])
+        raise(
+          ArgumentError,
+          format('Contains invalid character %p for XML 1.0: %p', $&, value)
+        )
       end
     end
   end