stashify-google-cloud-storage 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 750d4b6d827c4d277ac656444a240c85965c878639c7325237e45f913f1abd59
-  data.tar.gz: c0250df28f855b1ca9021f76342443ee1ea6d87c819fd1a71c0f9104f9d5d35e
+  metadata.gz: bd0b2c9765b2e4114b50cef616bcb39bcbb263d5f6d591da9b36be9e25fd0fc4
+  data.tar.gz: 589647aa4834c56c9c1afac29f69a5ddcdc8693259e6e5040d1509724655ba03
 SHA512:
-  metadata.gz: ce690f10bbfedaa4495ce5a05dd13177987abbe2f0a4de51c952d37ef956ffb21e17594098c3349bd212bee5a4138f06d7c58c1e0e09146b8646d455470ae876
-  data.tar.gz: f0b44a9d62d003f591dc72513ed0caba827e5a5f77fc626df5de29d8fc1601f0b6cd1795a94120b2f8a4250d0e6f3e7bc211da8264682c18ad576c5721455334
+  metadata.gz: a6a04e2f86e2689f32c3c567bfac1431ea5e1e7512ec6c161d9f19196d524422c468be1e08ec6221983d605b7b52210c48b2b7af2f605fc86b6ada5e9e5b5d67
+  data.tar.gz: a323d70da2277db57b53061ee23dde13824dca04d2645e9dbab09aece2ab6f50c801212dc398a913b1c97223f271ee12baee0e8fa28b8416026d458714d88149

data/.rubocop.yml

@@ -2,9 +2,6 @@ AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
 
-Style/Documentation:
-  Enabled: false
-
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/Gemfile

@@ -17,4 +17,4 @@ gem "guard-rspec"
 gem "guard-rubocop"
 
 gem "byebug"
-gem "rantly"
+gem "stashify-contract"

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    stashify-google-cloud-storage (2.0.0)
+    stashify-google-cloud-storage (3.1.1)
       google-cloud-storage (~> 1.44.0)
-      stashify (~> 3.0.0)
+      stashify (~> 3.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
+    addressable (2.8.3)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     byebug (11.1.3)
@@ -95,7 +95,7 @@ GEM
       shellany (~> 0.0)
     os (1.1.4)
     parallel (1.22.1)
-    parser (3.2.1.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
@@ -131,14 +131,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.48.1)
+    rubocop (1.49.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.28.0)
@@ -151,7 +151,10 @@ GEM
       faraday (>= 0.17.5, < 3.a)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
-    stashify (3.0.0)
+    stashify (3.2.1)
+    stashify-contract (1.0.1)
+      rantly (~> 2.0.0)
+      rspec (~> 3.0)
     thor (1.2.1)
     trailblazer-option (0.1.2)
     uber (0.1.0)
@@ -168,10 +171,10 @@ DEPENDENCIES
   guard-rspec
   guard-rubocop
   rake (~> 13.0)
-  rantly
   reek (~> 6.1.4)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  stashify-contract
   stashify-google-cloud-storage!
 
 BUNDLED WITH

data/README.md

@@ -1,15 +1,13 @@
 # Stashify::GoogleCloudStorage
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stashify/google_cloud_storage`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is an implementation of the [Stashify](https://rubydoc.info/gems/stashify) abstraction for Google Cloud Storage. It operates under the assumption that the "/" in file names has the typical meaning of a path separater.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'stashify-google_cloud_storage'
+gem 'stashify-google-cloud-storage'
 ```
 
 And then execute:
@@ -18,11 +16,35 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install stashify-google_cloud_storage
+    $ gem install stashify-google-cloud-storage
 
 ## Usage
 
-TODO: Write usage instructions here
+This implementation is built on top of an instance of `Google::Cloud::Storage::Bucket`. The following usage is an abbreviated form to illustrate how to engage in this particular library. For a more extensive example see [Stashify's Usage](https://rubydoc.info/gems/stashify#usage).
+
+```ruby
+> require "google/cloud/storage"
+=> true
+> storage = Google::Cloud::Storage.new(project_id: "some-project-id")
+> bucket = storage.bucket("some-bucket-name")
+> require "stashify/file/google/cloud/storage"
+=> true
+> file = Stashify::File::Google::Cloud::Storage.new(bucket: bucket, path: "pa
+th/to/file")
+=> 
+#<Stashify::File::Google::Cloud::Storage:0x000055af8eb86800
+...
+> file.contents
+=> "foo"
+> require "stashify/directory/google/cloud/storage"
+=> true
+> dir = Stashify::Directory::Google::Cloud::Storage.new(bucket: bucket, path: "path/to")
+=> 
+#<Stashify::Directory::Google::Cloud::Storage:0x000055af8ebd6918
+...
+> dir.find("file") == file
+=> true
+```
 
 ## Development
 

data/lib/stashify/directory/google/cloud/storage.rb

@@ -8,6 +8,11 @@ module Stashify
   class Directory
     module Google
       module Cloud
+        # An implementation for interacting with Google Cloud Storage
+        # buckets as if they had directories with "/" as a path
+        # separator. In addition to a path, it also needs a
+        # Google::Cloud::Storage::Bucket object representing the
+        # bucket the file resides within.
         class Storage < Stashify::Directory
           attr_reader :bucket
 
@@ -16,18 +21,19 @@ module Stashify
             super(path: path)
           end
 
+          def parent
+            Stashify::Directory::Google::Cloud::Storage.new(
+              bucket: @bucket,
+              path: ::File.dirname(path),
+            )
+          end
+
           def files
             @bucket.files.map do |gcloud_file|
               find(::Regexp.last_match(1)) if gcloud_file.name =~ %r{^#{Regexp.escape(path)}/([^/]*)(/.*)?$}
             end.compact
           end
 
-          def ==(other)
-            self.class == other.class && @bucket == other.bucket && path == other.path
-          end
-
-          private
-
           def directory?(name)
             path = path_of(name)
             !@bucket.file(path) && !@bucket.files(prefix: path).empty?
@@ -37,13 +43,17 @@ module Stashify
             Stashify::Directory::Google::Cloud::Storage.new(bucket: @bucket, path: path_of(name))
           end
 
-          def file?(name)
+          def exists?(name)
             @bucket.file(path_of(name))
           end
 
           def file(name)
             Stashify::File::Google::Cloud::Storage.new(bucket: @bucket, path: path_of(name))
           end
+
+          def ==(other)
+            self.class == other.class && @bucket == other.bucket && path == other.path
+          end
         end
       end
     end

data/lib/stashify/file/google/cloud/storage.rb

@@ -6,6 +6,10 @@ module Stashify
   class File
     module Google
       module Cloud
+        # An implementation for interacting with files in Google Cloud
+        # Storage buckets. The constructor needs an instance of
+        # Google::Cloud::Storage::Bucket in order to know which bucket
+        # to interact with.
         class Storage < Stashify::File
           def initialize(bucket:, path:)
             @bucket = bucket
@@ -26,6 +30,10 @@ module Stashify
           def delete
             @bucket.file(path).delete
           end
+
+          def exists?
+            @bucket.file(path)
+          end
         end
       end
     end

data/lib/stashify/google/cloud/storage/version.rb

@@ -4,7 +4,7 @@ module Stashify
   module Google
     module Cloud
       module Storage
-        VERSION = "3.0.0"
+        VERSION = "3.1.1"
       end
     end
   end

data/stashify-google-cloud-storage.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/stashify/google/cloud/storage/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stashify-google-cloud-storage"
+  spec.version = Stashify::Google::Cloud::Storage::VERSION
+  spec.authors = ["Lambda Null"]
+  spec.email = ["lambda.null.42@gmail.com"]
+
+  spec.summary = "A Google Cloud Storage implementation of the Stashify abstraction"
+  spec.description = "Interact with Google Cloud Storage using the common building blocks provided by Stashify"
+  spec.homepage = "https://github.com/Lambda-Null/stashify-google-cloud-storage"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "google-cloud-storage", "~> 1.44.0"
+  spec.add_dependency "stashify", "~> 3.2.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stashify-google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Lambda Null
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-storage
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.1
 description: Interact with Google Cloud Storage using the common building blocks provided
   by Stashify
 email:
@@ -46,7 +46,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
@@ -60,9 +59,9 @@ files:
 - bin/setup
 - lib/stashify/directory/google/cloud/storage.rb
 - lib/stashify/file/google/cloud/storage.rb
-- lib/stashify/google/cloud/storage.rb
 - lib/stashify/google/cloud/storage/version.rb
 - sig/stashify/google_cloud_storage.rbs
+- stashify-google-cloud-storage.gemspec
 homepage: https://github.com/Lambda-Null/stashify-google-cloud-storage
 licenses:
 - MIT

data/.reek.yml

@@ -1,3 +0,0 @@
-detectors:
-  IrresponsibleModule:
-    enabled: false

data/lib/stashify/google/cloud/storage.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "google/cloud/storage/version"
-
-module Stashify
-  module Google
-    module Cloud
-      module Storage
-      end
-    end
-  end
-end