file_management 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f228b3fd51934e81872efdbe0c6a96ce2855488a
-  data.tar.gz: 91bfbcec0c954ad101d1c210ee97319d4d64906b
+  metadata.gz: 88c312355ea61cbfba9a546e150b5574fa1caf89
+  data.tar.gz: cf856f66875629a4f7e0afd08a4d7aa2306a01ad
 SHA512:
-  metadata.gz: 8ff71edf8b72d9056b22f9af7c73840794d66a9f9c4a35aa20fc9690d27021bbc87b4b9b64d2957272e61d024e5db61ac6a9bb1f6efe1f80899f644faa60eb56
-  data.tar.gz: da19b553b6a5aa0f329de759314d466f3cd05a563c6aa22f65270b906a81a387ac48428b05774ce4fcc6f5d9312ff7e9d184f51bbfbd438197254f8f933de1f2
+  metadata.gz: ae61e341e48a70d1646591d2c42e75ff2e2172de93e46cbeb99cb7b57adb736a9922b22436c19f3abf863b9d12f2c416fb37f8848ad451f7c08204bf31e408b1
+  data.tar.gz: 2221b42e944ed1129f3e50fc207a72af48f7b13b03529d19c0ceb39c32855f4397c0336aa90d87d6307d917dadf6cc2c087bfe0eff1e05d97014b941ce31fc57

data/README.md

@@ -1,9 +1,7 @@
 # FileManagement
 [![Build Status](https://travis-ci.org/Mikeks81/File-Management.svg?branch=master)](https://travis-ci.org/Mikeks81/File-Management)
 
-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/file_management`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Simple File Management library for creating, deleting, file stats and listing all files in a directory. Gem is still in the very early phase of development. Please feel free to make suggestions or identify bugs.
 
 ## Installation
 
@@ -25,6 +23,7 @@ Or install it yourself as:
 
 ### initialize
 You can initialize the gem by telling it the path you would like to manage (via path) and and file that would like to ignore (via excludes). If you don't specify a path it will set to './'
+
 ```
 FileManager.new
 => #<FileManager:0x007fe2ab267790 @path="./", @excludes="">
@@ -33,8 +32,58 @@ FileManager.new(path: '/some/cool/path', excludes: 'ignore_me.rb')
 => #<FileManager:0x007fe2ab20f608 @path="some/cool/path", @excludes="ignore_me.rb">
 ```
 
-### Methods
+## Methods
+### all_files
+returns an array of files in the directory
+all files listed in the excludes attribute are ignored and not added to the array
+```
+f = FileManager.new(path: '/some/cool/path', excludes: 'ignore_me.rb')
+f.all_files
+=> ["test.rb", "test1.rb", "test2.rb"]
+```
+### make_file(new_file)
+returns the file path of the newly created file
+returns false if the file name is already taken
+```
+f.make_file('new_file.rb')
+=> ["test/test/new_file.rb"]
+```
+### pwd(file)
+returns a string path
+returns false if file doesn't exist or isn't found
+```
+f.pwd('new_file.rb')
+=> "test/test/new_file.rb"
+```
+### file_exists?(file)
+returns a boolean value of true if the file exists in the given director and false if it doesn't
+```
+f.file_exists?('new_file.rb')
+=> true
+```
+### stats(file, request)
+A Wrapper for File::Stat. The first argument is the file and the second is the stat method you would like. Currently if the the method from File::State isn't chained onto the end it is not supported ( directory? is one )
+```
+f.stats('new_file.rb', 'birthtime')
+=> 2017-06-12 20:27:11 -0400
+
+f.stats('new_file.rb', 'ftype')
+=> "file"
+```
 
+### file_size(file)
+Gives you the file size in SI standard.
+```
+f.file_size('file_manager.rb')
+=> "1.77 kB"
+```
+
+### rename(file, new_name)
+Renames file if it's present in path. Returns 0 if successful and false if the file doesn't exist
+```
+f.rename('new_file.rb', 'new_shit.rb')
+=> 0
+```
 
 ## Development
 

data/file_management.gemspec

@@ -14,15 +14,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/Mikeks81/File-Management"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

data/lib/file_management/file_manager.rb

@@ -48,7 +48,7 @@ class FileManager
 
   def file_size(file)
     puts 'File does not exist' unless file_exists?(file)
-    Filesize.new(file, Filesize::SI).pretty
+    Filesize.new(File.size(pwd(file)), Filesize::SI).pretty
   end
 
   def make_file(file)
@@ -57,7 +57,7 @@ class FileManager
   end
 
   def rename(file, new_name)
-    return false unless file_exists?(File.split(new_name).last)
+    return false if file_exists?(File.split(new_name).last)
     File.rename(pwd(file), pwd(new_name))
   end
 

data/lib/file_management/version.rb

@@ -1,3 +1,3 @@
 module FileManagement
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_management
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2017-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler