stashify 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15c432cdab53f9a20369203af0e05bb8157413a622655ae28d4c36131f318a8b
-  data.tar.gz: 5e2d87b9a660825c36d4140fa1a5c30b1a5e10573edc34df7fb6cbcff7e5f802
+  metadata.gz: f8498e1f869ce0f940cbf5e1f1eb65d77fb0692b1df9446b86547a070dcaa6ae
+  data.tar.gz: f27dc8f8accaa1ec01c6aee2705cc3919205d168d82b8fab5b81aa452f90e24a
 SHA512:
-  metadata.gz: 73612ebce48eaf45c396d4277ea4e73a591ffb976589049101dc28c6cd8b4fbbd3ad376852db2a8e5deb0a8864982e10071821da47a2ca19e05b443e0054613a
-  data.tar.gz: a897048fb68343a37408a5bdc43bcf93f629621fea1d21235896f32b0800e643ab791feac51d32b17df73ed2fcc3141652e43fd4bc85deac757abd78c1410080
+  metadata.gz: d8123084aca3264108000f72216018ca1c6e4a7a6a99bdd82f4f7f4082515bc1fe9ce0d7f268a2bba73e5165e21de903e6c973965728e00dbc7fd4ae0d94a610
+  data.tar.gz: 6f42c931c5dd653fe30a252ff513c3d66ded53c43df31d7aae877eafca20c87e0c2e01d90d0f1df0cab16d2fe85c75eccf5976cec2e61113252f6df06f555f35

data/.reek.yml

@@ -19,3 +19,7 @@ detectors:
   ControlParameter:
     exclude:
       - Stashify::Directory#initialize
+
+  NilCheck:
+    exclude:
+      - Stashify::File#exists?

data/Gemfile

@@ -18,3 +18,5 @@ gem "guard-rubocop"
 
 gem "byebug"
 gem "stashify-contract"
+
+gem "yard"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stashify (3.1.0)
+    stashify (3.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -93,6 +93,9 @@ GEM
       rspec (~> 3.0)
     thor (1.2.1)
     unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   x86_64-linux
@@ -109,6 +112,7 @@ DEPENDENCIES
   rubocop (~> 1.21)
   stashify!
   stashify-contract
+  yard
 
 BUNDLED WITH
    2.2.33

data/README.md

@@ -1,16 +1,18 @@
 # Stashify
 
-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`. To experiment with that code, run `bin/console` for an interactive prompt.
+Stashify is a common abstraction to interact with several different storage mediums in a uniform way. Provided in this gem is an implementation of the local filesystem, but other gems provide other implementations.
 
-TODO: Delete this and the text above, and describe your gem
+* [Google Cloud Storage](https://github.com/Lambda-Null/stashify-google-cloud-storage)
+* [AWS S3](https://github.com/Lambda-Null/stashify-aws-s3)
+* [Azure Blob Storage](https://github.com/Lambda-Null/stashify-microsoft-azure-storage-blob)
+
+The uniform nature of these implementations allows results from one be passed to others. This not only affords you flexibility in your implementation and testing, but a simple way of transferring information from one storage provider to another.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'stashify'
-```
+	gem 'stashify'
 
 And then execute:
 
@@ -22,7 +24,89 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Provided in this gem is an implementation of local storage. Here is an example of how to use that implementation:
+
+	> require "stashify/file/local"
+	=> true
+	> file = Stashify::File::Local.new(path: "/tmp/foo")
+	=> #<Stashify::File::Local:0x000055a2a62f53c0 @contents="", @name="foo", @path="/tmp/foo">
+	> file.contents
+	=> "1\n"
+	> file.delete
+	=> true
+	> file.write("100")
+	=> 3
+	> file.contents
+	=> "100"
+	> file.delete
+	=> 1
+	> file.exists?
+	=> false
+	> require "stashify/directory/local"
+	> dir = Stashify::Directory::Local.new(path: "/tmp")
+	> file2 = dir.find("bar")
+	=> #<Stashify::File::Local:0x000055a2a62ff000 @contents="", @name="bar", @path="/tmp/bar">
+	> file2.contents
+	=> "2\n"
+	> dir.exists?(file.name)
+	=> false
+	> dir.write(Stashify::File.new(name: "foo", contents: "1"))
+	> dir.exists?("foo")
+	=> true
+	> dir.find("foo").contents
+	=> "1"
+	> dir.exists?("bar")
+	=> true
+	> dir.delete("bar")
+	=> 1
+	> dir.exists?("bar")
+	=> false
+	> subdir = dir.find("foobar")
+	=> 
+	#<Stashify::Directory::Local:0x000055a2a5ffb660
+	...
+	> subdir.files.map(&:name)
+	=> ["baz"]
+	> subfile = subdir.files.first
+	=> 
+	#<Stashify::File::Local:0x000055a2a62937b0
+	...
+	> subfile.name
+	=> "baz"
+	> subfile.contents
+	=> "3\n"
+
+To interact with `Stashify::File` implementations is through `exists?`, `contents`, `write` and `delete`. To interact with `Stashify::Directory` implementations, use the methods `exists?`, `find`, `write`, `delete` and `files`. Regardless of the implementation of `Stashify::Directory`, `find` will return and `write` will take implementations of `Stashify::File`.
+
+This consistency allows a lot of portability. For instance, pulling in a couple [other](https://github.com/Lambda-Null/stashify-google-cloud-storage) [gems](https://github.com/Lambda-Null/stashify-aws-s3) allows you to do cool things like this:
+
+	> require "stashify/directory/local"
+	=> true
+	> dir = Stashify::Directory::Local.new(path: "/tmp/foobar")
+	=> 
+	#<Stashify::Directory::Local:0x0000564d9e8f9f48
+	...
+	> dir.files.map(&:name)
+	=> ["baz"]
+	> require "stashify/directory/google/cloud/storage"
+	=> true
+	> gdir = Stashify::Directory::Google::Cloud::Storage.new(bucket: bucket, path
+	: "")
+	=> 
+	#<Stashify::Directory::Google::Cloud::Storage:0x0000564d9ee87140
+	...
+	> gdir.write(dir)
+	> gdir.files.map(&:name)
+	=> ["foobar"]
+	> require "stashify/directory/aws/s3"
+	=> true
+	> adir = Stashify::Directory::AWS::S3.new(bucket: bucket, path: "")
+	=> 
+	#<Stashify::Directory::AWS::S3:0x0000564da0851580
+	...
+	> adir.write(gdir)
+	> adir.files.map(&:name)
+	=> ["baz"]
 
 ## Development
 
@@ -34,6 +118,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stashify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/stashify/blob/master/CODE_OF_CONDUCT.md).
 
+If you wish to create an implementation for a new provider, the gem [stashify-contract](https://github.com/Lambda-Null/stashify-contract) provides shared examples which verifies the consistency which maintains portability. To have your gem included in the list above, it must implement these examples in the way documented in that gem.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/stashify/directory.rb

@@ -62,7 +62,9 @@ module Stashify
       self.class == other.class && name == other.name && path == other.path
     end
 
-    private
+    def file(name)
+      Stashify::File.new(path: path_of(name))
+    end
 
     def path_of(*name)
       ::File.join(path, *name)

data/lib/stashify/file.rb

@@ -23,6 +23,10 @@ module Stashify
       @contents = nil
     end
 
+    def exists?
+      !contents.nil?
+    end
+
     def ==(other)
       name == other.name && contents == other.contents
     end

data/lib/stashify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stashify
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/stashify.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/stashify/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stashify"
+  spec.version = Stashify::VERSION
+  spec.authors = ["Lambda Null"]
+  spec.email = ["lambda.null.42@gmail.com"]
+
+  spec.summary = "Common abstraction for storing files"
+  spec.description = "Provides an abstraction to various services (local filesystem, S3, etc)"
+  spec.homepage = "https://github.com/Lambda-Null/stashify"
+  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 "example-gem", "~> 1.0"
+
+  # 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
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Lambda Null
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies: []
 description: Provides an abstraction to various services (local filesystem, S3, etc)
 email:
@@ -38,6 +38,7 @@ files:
 - lib/stashify/local.rb
 - lib/stashify/version.rb
 - sig/stashify.rbs
+- stashify.gemspec
 homepage: https://github.com/Lambda-Null/stashify
 licenses:
 - MIT