sheets_db 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdf056137eb54d33c6647240ada1498ca2527d44fe68dd8f170882ecff233725
-  data.tar.gz: 61d76eff207e4d88bbad700ea9be592dbdbac4a2d709a1883c53dbeae055790e
+  metadata.gz: a6eb0913dc274c00619b8de23c709d73676e64e233294469c00c2eb549afcfbb
+  data.tar.gz: ffeaa1616416edd4fa9529c982fce59f39594ec27b6d43eb7da16c5c086824cb
 SHA512:
-  metadata.gz: a589ac3ae9d86b63b65691d12ef212323f1ea9266bb8e2230b67972781ba0ca5ec812f3befc0341f67261e16e70fb1511bce37103583ee452869fef1df7bc24b
-  data.tar.gz: a71d6cf51c4795e6d4185e27c37a0dadf51ea2ec8fdf55607586e510e3a437723f508a20ed7c52fb50373c98c08e8c0cfa74289b5b3da40414241a0079c520f0
+  metadata.gz: 06d3c6c10ed9009cfd370de72fd9afc8b4393b77512149fa6043a04c787086822b9c5fd165f21666c3c6612417a77c279ea6fa2023046b6a565dfe7532264f30
+  data.tar.gz: 73b8d7c1d5a7b79061af23414984597a66d1e2accf9e7a59c84a8e58e7e53726e66869dc258f60a74b036993156f14c889583be95cf8eb2f8e18176705113edf

data/.ruby-version

@@ -1 +1 @@
-3.0.
+3.1.

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/lib/sheets_db/collection.rb

@@ -1,18 +1,63 @@
 module SheetsDB
   class Collection < Resource
+    class SpreadsheetNotFoundError < Resource::ChildResourceNotFoundError; end
+
     set_resource_type GoogleDrive::Collection
 
-    def self.has_many(resource, class_name:, resource_type: :subcollections)
-      unless [:subcollections, :spreadsheets].include?(resource_type)
-        raise ArgumentError, "resource_type must be :subcollections or :spreadsheets"
+    class << self
+      def has_many(resource, class_name:, resource_type: :subcollections)
+        unless [:subcollections, :spreadsheets].include?(resource_type)
+          raise ArgumentError, "resource_type must be :subcollections or :spreadsheets"
+        end
+        register_association(resource, class_name: class_name, resource_type: resource_type)
+        define_method(resource) do
+          @associated_resources ||= {}
+          @associated_resources[resource] ||= google_drive_resource.send(resource_type).map { |raw|
+            Support.constantize(class_name).new(raw)
+          }
+        end
       end
-      register_association(resource, class_name: class_name, resource_type: resource_type)
-      define_method(resource) do
-        result = instance_variable_get(:"@#{resource}")
-        result || instance_variable_set(:"@#{resource}",
-          google_drive_resource.send(resource_type).map { |raw| Support.constantize(class_name).new(raw) }
-        )
+    end
+
+    %i[
+      spreadsheet
+      subcollection
+    ].each do |child_resource_type|
+      define_method :"google_drive_#{child_resource_type}_by_title" do |title, **kwargs|
+        find_child_google_drive_resource_by(type: child_resource_type, title: title, **kwargs)
       end
     end
+
+    def find_spreadsheet(title:)
+      find_spreadsheet!(title: title)
+    rescue ChildResourceNotFoundError
+      nil
+    end
+
+    def find_spreadsheet!(title:)
+      find_and_wrap_spreadsheet!(title: title, create: false)
+    end
+
+    def find_or_create_spreadsheet!(title:)
+      find_and_wrap_spreadsheet!(title: title, create: true)
+    end
+
+    def find_and_wrap_spreadsheet!(title:, create: false)
+      Spreadsheet.new(google_drive_spreadsheet_by_title(title, create: create))
+    rescue ChildResourceNotFoundError
+      raise SpreadsheetNotFoundError
+    end
+
+    def spreadsheets
+      @anonymous_resources ||= {}
+      @anonymous_resources[:spreadsheets] ||=
+        google_drive_resource.spreadsheets.map { |raw| Spreadsheet.new(raw) }
+    end
+
+    def collections
+      @anonymous_resources ||= {}
+      @anonymous_resources[:collections] ||=
+        google_drive_resource.subcollections.map { |raw| Collection.new(raw) }
+    end
   end
-end
+end

data/lib/sheets_db/resource.rb

@@ -2,6 +2,7 @@ module SheetsDB
   class Resource
     class ResourceTypeMismatchError < StandardError; end
     class CollectionTypeAlreadyRegisteredError < StandardError; end
+    class ChildResourceNotFoundError < StandardError; end
 
     class << self
       attr_reader :resource_type
@@ -17,8 +18,8 @@ module SheetsDB
 
       def find_by_id(id, session: SheetsDB::Session.default)
         google_drive_resource = session.raw_file_by_id(id)
-        if @resource_type && !google_drive_resource.is_a?(@resource_type)
-          fail(ResourceTypeMismatchError, "The file with id #{id} is not a #{@resource_type}")
+        if resource_type && !google_drive_resource.is_a?(resource_type)
+          fail(ResourceTypeMismatchError, "The file with id #{id} is not a #{resource_type}")
         end
         new(google_drive_resource)
       end
@@ -26,10 +27,10 @@ module SheetsDB
       def belongs_to_many(resource, class_name:)
         register_association(resource, class_name: class_name, resource_type: :parents)
         define_method(resource) do
-          result = instance_variable_get(:"@#{resource}")
-          result || instance_variable_set(:"@#{resource}",
-            google_drive_resource.parents.map { |id| Support.constantize(class_name).find_by_id(id) }
-          )
+          @associated_resources ||= {}
+          @associated_resources[resource] ||= google_drive_resource.parents.map { |id|
+            Support.constantize(class_name).find_by_id(id)
+          }
         end
       end
 
@@ -43,6 +44,15 @@ module SheetsDB
           class_name: class_name
         }
       end
+
+      def association_methods_for_type(type)
+        raise ArgumentError unless %i[spreadsheet worksheet subcollection].include?(type)
+
+        google_type = type == :spreadsheet ? :file : type
+        create_prefix = type == :worksheet ? :add : :create
+
+        OpenStruct.new(find: :"#{google_type}_by_title", create: :"#{create_prefix}_#{type}")
+      end
     end
 
     extend Forwardable
@@ -56,6 +66,16 @@ module SheetsDB
       @google_drive_resource = google_drive_resource
     end
 
+    def reload!
+      @associated_resources = nil
+      @anonymous_resources = nil
+      google_drive_resource.reload_metadata
+    end
+
+    def delete!
+      google_drive_resource.delete
+    end
+
     def ==(other)
       other.is_a?(self.class) &&
         other.google_drive_resource == google_drive_resource
@@ -75,5 +95,14 @@ module SheetsDB
         updated_at: updated_at
       }
     end
+
+    def find_child_google_drive_resource_by(type:, title:, create: false)
+      association_methods = self.class.association_methods_for_type(type)
+      child_resource = google_drive_resource.public_send(association_methods.find, title)
+      child_resource ||= google_drive_resource.public_send(association_methods.create, title) if create
+      raise ChildResourceNotFoundError, [self, type, title] if child_resource.nil?
+
+      child_resource
+    end
   end
 end

data/lib/sheets_db/spreadsheet.rb

@@ -1,37 +1,31 @@
 module SheetsDB
   class Spreadsheet < Resource
     class WorksheetAssociationAlreadyRegisteredError < StandardError; end
-    class WorksheetNotFoundError < StandardError; end
+    class WorksheetNotFoundError < Resource::ChildResourceNotFoundError; end
+    class LastWorksheetCannotBeDeletedError < StandardError; end
 
     set_resource_type GoogleDrive::Spreadsheet
 
-    def self.has_many(resource, worksheet_name:, class_name:)
-      register_worksheet_association(resource, worksheet_name: worksheet_name, class_name: class_name)
-      create_worksheet_association(resource, worksheet_name: worksheet_name, class_name: class_name)
-    end
+    class << self
+      def has_many(resource, worksheet_name:, class_name:)
+        register_worksheet_association(resource, worksheet_name: worksheet_name, class_name: class_name)
+        create_worksheet_association(resource, worksheet_name: worksheet_name, class_name: class_name)
+      end
 
-    def self.register_worksheet_association(resource, worksheet_name:, class_name:)
-      @associations ||= {}
-      if @associations.fetch(resource, nil)
-        raise WorksheetAssociationAlreadyRegisteredError
+      def register_worksheet_association(resource, worksheet_name:, class_name:)
+        @associations ||= {}
+        if @associations.fetch(resource, nil)
+          raise WorksheetAssociationAlreadyRegisteredError
+        end
+        @associations[resource] = {
+          worksheet_name: worksheet_name,
+          class_name: class_name
+        }
       end
-      @associations[resource] = {
-        worksheet_name: worksheet_name,
-        class_name: class_name
-      }
-    end
 
-    def self.create_worksheet_association(resource, worksheet_name:, class_name:)
-      define_method(resource) do
-        @worksheets ||= {}
-        @worksheets[resource] ||= begin
-          google_drive_worksheet = google_drive_resource.worksheet_by_title(worksheet_name)
-          raise WorksheetNotFoundError, worksheet_name if google_drive_worksheet.nil?
-          Worksheet.new(
-            spreadsheet: self,
-            google_drive_resource: google_drive_worksheet,
-            type: Support.constantize(class_name)
-          )
+      def create_worksheet_association(resource, **kwargs)
+        define_method(resource) do
+          worksheet_association(resource, **kwargs)
         end
       end
     end
@@ -51,5 +45,65 @@ module SheetsDB
     def select_from_association(association_name, &block)
       send(association_name).select(&block)
     end
+
+    def worksheet_association(association_name, worksheet_name:, class_name:)
+      @associated_resources ||= {}
+      @associated_resources[association_name] ||=
+        find_or_create_worksheet!(title: worksheet_name, type: Support.constantize(class_name))
+    end
+
+    def worksheets
+      @anonymous_resources ||= {}
+      @anonymous_resources[:worksheets] ||= google_drive_resource.worksheets.map { |raw|
+        set_up_worksheet!(google_drive_resource: raw)
+      }
+    end
+
+    def set_up_worksheet!(google_drive_resource:, type: nil)
+      wrap_worksheet(google_drive_resource: google_drive_resource, type: type).set_up!
+    end
+
+    def wrap_worksheet(google_drive_resource:, type: nil)
+      Worksheet.new(
+        google_drive_resource: google_drive_resource,
+        spreadsheet: self,
+        type: type
+      )
+    end
+
+    def find_worksheet(title:, type: nil)
+      find_worksheet!(title: title, type: type)
+    rescue WorksheetNotFoundError
+      nil
+    end
+
+    def find_worksheet!(title:, type: nil)
+      find_and_setup_worksheet!(title: title, type: type, create: false)
+    end
+
+    def find_or_create_worksheet!(title:, type: nil)
+      find_and_setup_worksheet!(title: title, type: type, create: true)
+    end
+
+    def find_and_setup_worksheet!(title:, type: nil, create: false)
+      resource = google_drive_worksheet_by_title(title, create: create)
+      set_up_worksheet!(google_drive_resource: resource, type: type)
+    rescue ChildResourceNotFoundError
+      raise WorksheetNotFoundError
+    end
+
+    def clean_up_default_worksheet!(force: false)
+      default_sheet = google_drive_resource.worksheet_by_title("Sheet1")
+      return unless default_sheet
+
+      raise LastWorksheetCannotBeDeletedError if google_drive_resource.worksheets.count == 1
+
+      wrap_worksheet(google_drive_resource: default_sheet).
+        delete_google_drive_resource!(force: force)
+    end
+
+    def google_drive_worksheet_by_title(title, **kwargs)
+      find_child_google_drive_resource_by(type: :worksheet, title: title, **kwargs)
+    end
   end
 end

data/lib/sheets_db/version.rb

@@ -1,3 +1,3 @@
 module SheetsDB
-  VERSION = "0.11.0"
+  VERSION = "0.13.0"
 end

data/lib/sheets_db/worksheet/row.rb

@@ -172,6 +172,7 @@ module SheetsDB
       def reload!
         worksheet.reload!
         reset_attributes_and_associations_cache
+        self
       end
 
       def save!
@@ -179,6 +180,7 @@ module SheetsDB
         worksheet.update_attributes_at_row_position(staged_attributes, row_position: row_position)
         save_changed_foreign_items!
         reset_attributes_and_associations_cache
+        self
       end
 
       def assign_next_row_position_if_not_set
@@ -192,6 +194,7 @@ module SheetsDB
       def reset_attributes_and_associations_cache
         @loaded_attributes = {}
         @loaded_associations = {}
+        self
       end
 
       def staged_attributes

data/lib/sheets_db/worksheet.rb

@@ -1,21 +1,44 @@
+require 'bigdecimal/util'
 require_relative "worksheet/column"
 require_relative "worksheet/row"
 
 module SheetsDB
   class Worksheet
     class ColumnNotFoundError < StandardError; end
+    class WorksheetContainsDataError < StandardError; end
 
     include Enumerable
+    extend Forwardable
 
-    attr_reader :spreadsheet, :google_drive_resource, :type, :synchronizing
+    attr_reader :spreadsheet, :google_drive_resource, :synchronizing
 
-    def initialize(spreadsheet:, google_drive_resource:, type:)
+    def_delegator :google_drive_resource, :title
+
+    def initialize(spreadsheet:, google_drive_resource:, type: nil)
       @spreadsheet = spreadsheet
       @google_drive_resource = google_drive_resource
       @type = type
       @synchronizing = true
     end
 
+    def set_up!
+      if google_drive_resource.num_rows == 0
+        registered_column_names = attribute_definitions.map { |name, definition| definition[:column_name] }
+        write_matrix!([registered_column_names])
+      end
+      self
+    end
+
+    def type
+      @type || @generated_type ||= begin
+        Class.new(Row).tap { |generated_type_class|
+          column_names.each do |name|
+            generated_type_class.attribute name.to_sym
+          end
+        }
+      end
+    end
+
     def ==(other)
       other.is_a?(self.class) &&
         other.google_drive_resource == google_drive_resource &&
@@ -31,7 +54,8 @@ module SheetsDB
     def columns
       @columns ||= begin
         {}.tap { |directory|
-          google_drive_resource.rows.first.each_with_index do |name, i|
+          header_row = google_drive_resource.rows.first || []
+          header_row.each_with_index do |name, i|
             unless name == ""
               directory[name] = Column.new(name: name, column_position: i + 1)
             end
@@ -98,12 +122,20 @@ module SheetsDB
 
     def update_attributes_at_row_position(staged_attributes, row_position:)
       staged_attributes.each do |attribute_name, value|
-        attribute_definition, column = get_definition_and_column(attribute_name)
-        raise ColumnNotFoundError, column unless column
-        assignment_value = attribute_definition[:multiple] ? value.join(",") : value
-        google_drive_resource[row_position, column.column_position] = assignment_value
+        update_attribute_at_row_position(
+          attribute_name: attribute_name,
+          value: value,
+          row_position: row_position
+        )
       end
-      google_drive_resource.synchronize if synchronizing
+      synchronize! if synchronizing
+    end
+
+    def update_attribute_at_row_position(attribute_name:, value:, row_position:)
+      attribute_definition, column = get_definition_and_column(attribute_name)
+      raise ColumnNotFoundError, column unless column
+      assignment_value = attribute_definition[:multiple] ? value.join(",") : value
+      google_drive_resource[row_position, column.column_position] = assignment_value
     end
 
     def next_available_row_position
@@ -163,7 +195,11 @@ module SheetsDB
     end
 
     def reload!
+      @columns = nil
+      @existing_raw_data = nil
+      @generated_type = nil
       google_drive_resource.reload
+      self
     end
 
     def convert_to_boolean(raw_value)
@@ -180,8 +216,8 @@ module SheetsDB
       converted_value = case attribute_definition[:type].to_s
       when "Integer"
         raw_value.to_i
-      when "Float"
-        raw_value.to_f
+      when "Decimal"
+        raw_value.to_d
       when "DateTime"
         DateTime.strptime(raw_value, "%m/%d/%Y %H:%M:%S")
       when "Boolean"
@@ -205,9 +241,66 @@ module SheetsDB
     def transaction
       disable_synchronization!
       yield
-      google_drive_resource.synchronize
+      synchronize!
     ensure
       enable_synchronization!
     end
+
+    def delete_google_drive_resource!(force: false)
+      raise WorksheetContainsDataError if google_drive_resource.num_rows.nonzero? && !force
+
+      google_drive_resource.delete
+      @google_drive_resource = nil
+      spreadsheet.reload!
+    end
+
+    def truncate!
+      clear_google_drive_resource!
+      set_up!
+      reload!
+    end
+
+    def write_matrix(matrix, rewrite: false, save: false)
+      clear_google_drive_resource if rewrite
+      google_drive_resource.update_cells(1, 1, matrix)
+      synchronize! if save
+      self
+    end
+
+    def write_matrix!(matrix, **options)
+      write_matrix(matrix, **options.merge(save: true))
+    end
+
+    def write_raw_data(data, **options)
+      raise ArgumentError, "mismatched keys" if data.map(&:keys).uniq.count > 1
+
+      write_matrix(data.map(&:values).prepend(data.first.keys), **options)
+    end
+
+    def write_raw_data!(data, **options)
+      write_raw_data(data, **options.merge(save: true))
+    end
+
+    def clear_google_drive_resource(save: false)
+      empty_matrix = Array.new(google_drive_resource.num_rows, Array.new(google_drive_resource.num_cols))
+      write_matrix(empty_matrix, save: save)
+    end
+
+    def clear_google_drive_resource!
+      clear_google_drive_resource(save: true)
+    end
+
+    def synchronize!
+      google_drive_resource.synchronize
+      @existing_raw_data = nil
+      self
+    end
+
+    def existing_raw_data
+      @existing_raw_data ||= begin
+        rows = google_drive_resource.rows
+        rows.drop(1).map { |row| Hash[rows.first.zip(row)] }
+      end
+    end
   end
 end

data/sheets_db.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "google_drive", "~> 3.0"
 
-  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "bundler", "~> 2.4"
   spec.add_development_dependency "rake", "~> 13"
-  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rspec", "~> 3.11"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "guard-rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sheets_db
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Ravi Gadad
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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:
 email:
 - ravi@ablschools.com
@@ -93,6 +107,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -138,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Adapter for pseudo-relational data stored in Google Sheets