SafeFile 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6558e12a3e762649ebacd215e2bb1caac71b1c6e6a4559068cf01aaf8d9e6d6a
-  data.tar.gz: 3822d2a657ad366bad578c20261db62e9757ab0f4d004a0153d8026f9d86d253
+  metadata.gz: 2c5b4739556a960feae63b3085d755ea3c5b91fc4f8383f37e49d8a0dc4fc47b
+  data.tar.gz: b2956d94f0aac7aff9faf05df00e4ebbfbbb3105fbc629b75ec0ab3da66814ca
 SHA512:
-  metadata.gz: 34e1c8f4f354fe3077a64e17d5150c60a7bd0716409b2eb7b2fc6a7e206056020c2d2d362ea3f27cc85a754eac32c5450d33507c0f2fd9abc34b173c892e1a74
-  data.tar.gz: dac3916a294ff24517d7650b1a16fca6b2707064903d5380c721f40ca1e22bbc0840a037a6f6d67cb4b871f83359b6a3982dcf049af4231a497d7601e19b404f
+  metadata.gz: 8db76adc1b38de212357768348639cc6707a9fc62239719a8def8d7fbbb1fd985c9a9096089a4753ce0a79974ad728179e2d9d334da2e591b7dac58c9f9ccecc
+  data.tar.gz: 8229f627f8f831aec1e1a6355a32e79cd574fbf4e9cce3de0707f50f9be46aabd87845441df64384fe43f6d624afb0ce5d6291e3558aca191203224b8b65cb82

data/README.md

@@ -1,3 +1,35 @@
 # SafeFile
 
-Strict file access library for Ruby
+Strict file access library for Ruby
+
+## Installing
+> [!WARNING]
+> When installing this Gem, **capitalization matters**, for some reason..
+
+You can either use Gem
+```sh 
+gem install SafeFile
+```
+or put it in your Gemfile
+```gemfile 
+gem "SafeFile"
+```
+
+## Usage
+It's really easy to use this. You can use it the same way you'd use the File Class. It currently only supports these actions: `SafeFile.read`, `SafeFile.open`, `SafeFile.write`, `SafeFile.foreach`.
+
+### Adding safe directories
+By default, the parent working directory is marked as safe. You may change this with the line below
+```ruby 
+SafeFile.safe.allowPWD = false
+```
+If you'd like to add other safe directories you may use the `SafeFile.safe.append` method
+```ruby 
+SafeFile.safe.append "/tmp/projectCache"
+```
+or remove a safe directory with 
+```ruby 
+SafeFile.safe.remove "/tmp/projectCache"
+```
+
+If you need an example of everything, you may take a look at the test document located in the tests directory.

data/lib/safefile.rb

@@ -4,7 +4,7 @@ module SafeFile
   @@safeDirs = Array.new
   @@allowPWD = true
 
-  def open file
+  def self.open file
     file = file.gsub "~/", "#{ENV["HOME"]}/"
 
     if performCheck File.expand_path file
@@ -12,7 +12,7 @@ module SafeFile
     end
   end
 
-  def read file
+  def self.read file
     file = file.gsub "~/", "#{ENV["HOME"]}/"
 
     if performCheck File.expand_path file
@@ -20,7 +20,7 @@ module SafeFile
     end
   end
 
-  def write file, content
+  def self.write file, content
     file = file.gsub "~/", "#{ENV["HOME"]}/"
 
     if performCheck File.expand_path file
@@ -28,7 +28,17 @@ module SafeFile
     end
   end
 
-  def safe 
+  def self.foreach file, &block
+    file = file.gsub "~/", "#{ENV["HOME"]}/"
+
+    if performCheck File.expand_path file
+      File.foreach file do |line|
+        block.call line
+      end
+    end   
+  end
+
+  def self.safe 
     def append dir 
       dir = dir.gsub "~/", "#{ENV["HOME"]}/"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SafeFile
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Sky.Bit
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Strict file access library for Ruby
 test_files: []