sheets_db 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8186e2c37fc147e8bcc4fed8c4bf288b05dde2466c9145e24882d7e1c41d3d35
-  data.tar.gz: cdaf52978086b08fed7cd9635aed44ae2f06bfb756058f1eb4d4fc0bf73e8945
+  metadata.gz: d020639fc0646a740ab9afda00ac3bf8098835cc64c83789a08e323e4021f365
+  data.tar.gz: 6e9eed146d5b2e450f98830a02c6b882a9e415ba04a8c702a4df4757c6d2a1aa
 SHA512:
-  metadata.gz: 89fd0245435dcfe13010330ca1220bc1d1ec1082333583021cb65f1d74857f6886eebf4325d7f1107ccdc3a406eb58877c914ef3bbdab8b9c4f1e98ffedb7e70
-  data.tar.gz: 2575c45b0f15e24cdbe8296d79a0429eb8120a41414cf112328106b650c70142df3312de2e1d86ffe63ae7c65e32f839bf413ee94c3ea647deae2d2eb692d77a
+  metadata.gz: a82534bb2ee225da6656ce6a511e97fc3174376bde01af3c414e37d6336a756f0658b36f6c0b87426ac83bb38fed4874334fdc878ea02adcf7465d217789d223
+  data.tar.gz: 30012de7ca8856ef2b345e6e728585d53fa1e2e1a786424b62ed62053ebae67f1acf2afd0659fc9600f03764e951bf8084bde66eb73df0f392fb04f12ff723cd

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,5 +1,7 @@
 module SheetsDB
   class Collection < Resource
+    class SpreadsheetNotFoundError < Resource::ChildResourceNotFoundError; end
+
     set_resource_type GoogleDrive::Collection
 
     class << self
@@ -26,6 +28,26 @@ module SheetsDB
       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] ||=

data/lib/sheets_db/resource.rb

@@ -16,10 +16,26 @@ module SheetsDB
         @resource_type = resource_type
       end
 
+      def find(id_or_url, session: SheetsDB::Session.default)
+        find_by_url(id_or_url, session: session)
+      rescue SheetsDB::Session::InvalidGoogleDriveUrlError
+        find_by_id(id_or_url, session: session)
+      end
+
+      def find_by_url(url, session: SheetsDB::Session.default)
+        wrap_google_drive_resource(session.raw_file_by_url(url))
+      end
+
       def find_by_id(id, session: SheetsDB::Session.default)
-        google_drive_resource = session.raw_file_by_id(id)
+        wrap_google_drive_resource(session.raw_file_by_id(id))
+      end
+
+      def wrap_google_drive_resource(google_drive_resource)
         if resource_type && !google_drive_resource.is_a?(resource_type)
-          fail(ResourceTypeMismatchError, "The file with id #{id} is not a #{resource_type}")
+          fail(
+            ResourceTypeMismatchError,
+            "The file #{google_drive_resource.human_url} is not a #{resource_type}"
+          )
         end
         new(google_drive_resource)
       end

data/lib/sheets_db/session.rb

@@ -4,6 +4,7 @@ module SheetsDB
   class Session
     class IllegalDefaultError < StandardError; end
     class NoDefaultSetError < StandardError; end
+    class InvalidGoogleDriveUrlError < ArgumentError; end
 
     def self.default=(default)
       unless default.is_a?(self)
@@ -30,5 +31,12 @@ module SheetsDB
     def raw_file_by_id(id)
       @google_drive_session.file_by_id(id)
     end
+
+    def raw_file_by_url(url)
+      @google_drive_session.file_by_url(url)
+    rescue GoogleDrive::Error => e
+      (raise InvalidGoogleDriveUrlError, url) if e.message.match(/not a known Google Drive URL/)
+      raise
+    end
   end
-end
+end

data/lib/sheets_db/spreadsheet.rb

@@ -1,7 +1,8 @@
 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
 
@@ -59,16 +60,46 @@ module SheetsDB
     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
-      ).set_up!
+      )
+    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)
-      resource = google_drive_worksheet_by_title(title, create: true)
+      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)

data/lib/sheets_db/version.rb

@@ -1,3 +1,3 @@
 module SheetsDB
-  VERSION = "0.12.0"
+  VERSION = "0.14.0"
 end

data/lib/sheets_db/worksheet.rb

@@ -1,18 +1,22 @@
+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, :worksheet_title, :google_drive_resource, :synchronizing
+    attr_reader :spreadsheet, :google_drive_resource, :synchronizing
+
+    def_delegator :google_drive_resource, :title
 
     def initialize(spreadsheet:, google_drive_resource:, type: nil)
       @spreadsheet = spreadsheet
       @google_drive_resource = google_drive_resource
-      @worksheet_title = google_drive_resource.title
       @type = type
       @synchronizing = true
     end
@@ -212,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"
@@ -242,7 +246,9 @@ module SheetsDB
       enable_synchronization!
     end
 
-    def delete_google_drive_resource!
+    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!

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.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.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Ravi Gadad
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2024-08-20 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
@@ -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