fos 1.0.3 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bad468a812602dce0121eda26a1dcf3ce5080d0
+  data.tar.gz: ebc6523c478fb9cb951fff9f966d1eb338da5418
+SHA512:
+  metadata.gz: ecadbddef56a2527dedcd9b3364a44bd5132276bee84c630c6863fa1171ed3f0dc9b95ca82557dff295c6d1c49104603f347d141dfc86edd25ebb36cf9a61680
+  data.tar.gz: b155237029ae2f54a2395ecd6460beb695d139eea9ceb135da4f019d4464bfbe3e6894df1d33c3827806b35af571b26f69e4121ebd2796d1186afca4f49929d0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: "bundle exec rake"
+notifications:
+  email:
+    recipients:
+      - me@scottyg.net
+    on_failure: change
+    on_success: never

data/README.md

@@ -1,19 +1,63 @@
 # fos
 
-A Desktop and Download Folder Archiver
+[![Gem Version](https://badge.fury.io/rb/fos.svg)](http://badge.fury.io/rb/fos) [![Build Status](https://travis-ci.org/scottyg/fos.svg?branch=master)](https://travis-ci.org/scottyg/fos)
+
+Fos is a folder archive tool for Linux or Mac. By default Fos archives ~/Desktop and ~/Downloads, but can easily archive any folder.
 
 ## Installation
 
-    gem install fos
+Fos is a Ruby Gem and can be easily installed with the command `gem install fos`.
+
+If you do not yet have [ruby installed](https://www.ruby-lang.org/en/installation/) you will need to do that first.
 
 ## Usage
 
-    fos
+Basic usage is `fos` and archives ~/Desktop and ~/Downloads.
+
+`fos -h` shows you options.
+
+```
+Options
+    -p, --path PATH
+    -n, --name NAME
+    -z, --zip
+    -h, --help
+    -v, --version
+```
+
+###Examples:
+
+`fos -p /path/to/folder`
+
+Archives the contents of /path/to/folder into /path/to/folder/archive
+
+`fos -n new_name`
+
+Archives the contents of ~/Desktop and ~/Downloads into ~/Desktop/new_name and ~/Downloads/new_name respectively.
+
+`fos -z`
+
+Archives and zips the contents of ~/Desktop and ~/Downloads into ~/Desktop/archive.zip and ~/Downloads/archive.zip respectively.
+
+`fos -p /path/to/folder -n new_name -z`
+
+Archives and zips the contents of /path/to/folder into /path/to/folder/new_name.zip.
+
+###Config
+
+Config file located at ~/.fos/config.yml
+
+## Development
+
+First time installing for dev on your system run `bundle install`
+
+Then run `rake install` to build Fos from source
 
 ## Roadmap
 
-- Archive specific paths
-- Zip archive
+- Archive specific names[testing]
+- Archive specific paths[testing]
+- Zip archive[testing]
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/bin/fos

@@ -3,4 +3,4 @@
 require 'fos'
 
 action = Fos::Action.new
-action.move
+action.archive

data/fos.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Fos::VERSION
   spec.authors       = ["Scott Gordon"]
   spec.email         = ["me@scottyg.net"]
-  spec.summary       = %q{A Desktop and Download Folder Archiver}
-  spec.description   = %q{A Desktop and Download Folder Archiver}
+  spec.summary       = %q{a folder archive tool for Linux or Mac}
+  spec.description   = %q{a folder archive tool for Linux or Mac}
   spec.homepage      = "http://scottyg.github.io/fos/"
   spec.license       = "MIT"
 
@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
-end
+  spec.add_development_dependency "colorize", "~> 0.7.3"
+  
+end

data/lib/fos/version.rb

@@ -1,3 +1,3 @@
 module Fos
-  VERSION = "1.0.3"
+  VERSION = "2.0.0"
 end

data/lib/fos.rb

@@ -1,50 +1,142 @@
+# Full Of Shit
 require "fos/version"
+require 'optparse'
+require 'colorize'
+require 'yaml'
 
 module Fos
+  
   class Action
-    def move
+    def archive
+     
+      options = {}
       
-      # General Variables
-      username = File.expand_path('~')
-      folder = "archive" # New Folder Name
+      # Option parser 'optparse'
+      opt_parser = OptionParser.new do |opt|
+        opt.banner = "Fos is a folder archive tool for Linux or Mac."
+        opt.separator  ""
+        opt.separator  "Archives ~/Desktop and ~/Downloads by default"
+        opt.separator  ""
+        opt.separator  "Usage: fos [OPTIONS]"
+        opt.separator  ""
+        opt.separator  "Options"
+        opt.on("-p","--path PATH","Input path(s), BE CAREFUL WITH THIS") do |path|
+          options[:path] = path
+        end
+        opt.on("-n","--name NAME","Output name, default is archive") do |name|
+          options[:name] = name
+        end
+        opt.on("-z","--zip","Output as zip file, default is false") do |zip|
+          options[:zip] = zip
+        end
+        opt.on("-h","--help","help") do |help|
+          puts opt_parser
+          options[:help] = help
+        end
+        opt.on("-v","--version","version") do |version|
+          puts Fos::VERSION
+          options[:version] = version
+        end
+      end
+
+      begin opt_parser.parse! ARGV
+      rescue OptionParser::InvalidOption => e
+        puts e
+        puts "Try fos -h"
+        exit 1
+      end
+      
+      user_path = File.expand_path('~')
+      
+      # Config file
+      if !File.directory?("#{user_path}/.fos")
+        `mkdir #{user_path}/.fos`
+        `touch #{user_path}/.fos/config.yml`
+        open("#{user_path}/.fos/config.yml", 'w') { |f|
+          f.puts "name: archive"
+          f.puts "paths: [#{user_path}/Desktop, #{user_path}/Downloads]"
+        }
+      end
+      
+      hash = YAML.load(File.read("#{user_path}/.fos/config.yml"))
+      
+      # Option variables
+      path = options[:path] || nil
+      archive_name = options[:name] || hash['name']
+      zip = options[:zip] || false
+      version = options[:version] || false
+      help = options[:help] || false
+	  
+      folders = hash['paths']
       today = Time.now.strftime("%B %e %Y").gsub(' ', '_').gsub(/:.*/, '')
-      default_folders = ['Desktop', 'Downloads']
+            
+      # Look for commands
+      case ARGV[0]
+      when "shit"
+        puts "I can clean that up for you"
+      else
+         do_archive = true
+      end
       
-      # Do for each folder
-      default_folders.each do |this_folder|
-        
-        # Get Path
-        current_path = "#{username}/#{this_folder}"
+      # Check if help or version option, Disable archive
+      if help == true || version == true
+        do_archive = false
+      end
+      
+      # Set new path if option is set
+      if !path.nil?
+      	folders = path.split(',')
+        folders.each do |f|
+          f.sub! "~", "#{user_path}"
+        end
+      end
+      
+      if do_archive == true
+        # Do for each folder
+        folders.each do |current_path|
         
-        # Get Files
-        current_files = Dir.entries(current_path)
+          # Get files
+          current_files = Dir.entries(current_path)
         
-        # Create Folders
-        if !File.directory?("#{current_path}/#{folder}")
-          `mkdir #{current_path}/#{folder}`
-        end
-        if !File.directory?("#{current_path}/#{folder}/#{today}")
-          `mkdir #{current_path}/#{folder}/#{today}`
-        end
+          # Create folders
+          if !File.directory?("#{current_path}/#{archive_name}")
+            `mkdir #{current_path}/#{archive_name}`
+            puts "[ " + "Creating".yellow + ": "+"#{current_path}/#{archive_name}"+" ]"
+          end
+          if !File.directory?("#{current_path}/#{archive_name}/#{today}")
+            `mkdir #{current_path}/#{archive_name}/#{today}`
+            puts "[ " + "Creating".yellow + ": "+"#{current_path}/#{archive_name}/#{today}"+" ]"
+          end
         
-        # Remove System Folders And Our New Folder
-        current_files.delete_if{|x| (x =~ /^\./) == 0 }
-        current_files.delete_if{|x| x == "#{folder}"}
-        current_files.delete_if{|x| (x =~ /Macintosh/) == 0}
+          # Remove system folders and our new folder
+          current_files.delete_if{|x| (x =~ /^\./) == 0 }
+          current_files.delete_if{|x| x == "#{archive_name}"}
+          current_files.delete_if{|x| (x =~ /Macintosh/) == 0}
           
-        # Clean File names
-        current_files = current_files.map{|x| x.gsub(" ", '\ ').gsub("(", '\(').gsub(")", '\)')}
-        
-        # Do The Moving
-        current_files.each do |filename|
-          `mv #{current_path}/#{filename} #{current_path}/#{folder}/#{today}`
-        end
+          # Clean file names
+          current_files = current_files.map{|x| x.gsub(" ", '\ ').gsub("(", '\(').gsub(")", '\)')}
         
-        # Finished
-        puts "Cleaned #{current_path}"
+          # Do the moving
+          current_files.each do |filename|
+            `mv #{current_path}/#{filename} #{current_path}/#{archive_name}/#{today}`
+            puts "[ " + "Archiving".yellow + ": "+"#{current_path}/#{filename}"+" ]"
+          end
         
+          # Do zip if option is set
+          if zip == true
+            puts "[ " + "Zipping".yellow + ": #{current_path} ]"
+            `zip -r #{current_path}/#{archive_name}.zip #{current_path}/#{archive_name}`
+            # Add extension name for finishing message
+            tmp_archive_name = archive_name + ".zip"
+          else
+            tmp_archive_name = archive_name
+          end
+          
+          # Finished
+          puts "[ " + "Archived".colorize(:green) + ": "+"#{current_path} "+"into"+" #{current_path}/#{tmp_archive_name}"+" ]"
+          
+        end
       end
-      
     end
   end
 end

metadata

@@ -1,49 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: fos
 version: !ruby/object:Gem::Version
-  version: 1.0.3
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Scott Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Desktop and Download Folder Archiver
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+description: a folder archive tool for Linux or Mac
 email:
 - me@scottyg.net
 executables:
@@ -51,7 +60,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -63,26 +73,25 @@ files:
 homepage: http://scottyg.github.io/fos/
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: A Desktop and Download Folder Archiver
+specification_version: 4
+summary: a folder archive tool for Linux or Mac
 test_files: []