attic-cleanup 0.0.2

data/README.md

@@ -0,0 +1,99 @@
+Attic-Cleanup
+=============
+
+About
+=====
+Attic-cleanup is a gem to manage files on your computer.
+
+If you ever feel like you need to store your files you can throw them in your attic.
+
+Let's say your attic is filled with files and folders and you just want to get them out of the way.
+
+If you use the attic-cleanup gem all the files in the specified location will be moved into ~/MyAttic/Date-today.
+
+An example of Date-today is ~/MyAttic/2011-11-23.
+
+You can set specific location that you want to manage and create shortcuts for them.
+
+A log will be kept of which files are moved to where, so if you ever forgot where you stored a specific file
+
+you can find it in the log.txt file in the MyAttic folder.
+
+
+Notes
+=====
+This gem has NOT been tested on Windows, and there's a big chance it won't work correctly.
+
+This gem is still in beta, and moves, creates and deletes files / folders.
+
+I use this gem every day and have never lost any folders or files.
+
+However, if something does go wrong and you lose any files or folders I will not be held responsible.
+
+Use at own risk
+
+Installation
+============
+gem install attic-cleanup
+
+
+Usage
+=====
+Attic-cleanup is easy to use.
+Here are a few examples to help you understand how to use it.
+
+Example: We want to store all the files from our Desktop into MyAttic.
+======================================================================
+attic-cleanup store -a -f
+
+This line will store all the files from your Desktop to the MyAttic folder.
+
+-a is an option to selected all the files.
+
+-f is an option to force move everything, you wont have to type "y" to confirm.
+
+You don't have to specify a path because Desktop is automatically the default location.
+
+If you want to change your default location, you can simply do that in the default_path.txt file.
+
+
+Another Example: I want to move certain items from my Projects folder, I made a shortcut called projects
+========================================================================================================
+attic-cleanup store @projects
+
+
+This line will take you to the projects folder, the @ sign stands for shortcut.
+
+In the custom_paths.txt file you can set your own shortcuts. You can also create them with the 'new' command.
+
+It's easy to do and there are already a few pre-generated shortcuts for you.
+
+Since we didn't use the -a option, we can choose which files we want to store.
+
+Now type 'ls' to view all the files and their IDs.
+
+Then type the IDs of the files you wish to store. example: 1,3,6,12,25
+
+Press enter, since we didn't use the -f option we will be asked if we want to move the files.
+
+Type y to continue or type n to exit.
+
+Once you press y all the file will be moved to the MyAttic folder and every file will be printed in the log.txt file.
+
+
+Checking which shortcuts are available
+======================================
+attic-cleanup shortcuts
+
+
+This will display every shortcut in the custom_paths.txt file.
+
+
+Creating a new shortcut with the 'new' command
+==============================================
+attic-cleanup new --name projects --path ~/MyProjects/CurrentProject
+
+
+This will generate a new shortcut. The shortcut name will be @projects and the path will be ~/MyProjects/CurrentProject
+
+You can always adjust shortcuts and default location in MyAttic folder.

data/bin/attic-cleanup

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.expand_path("../../lib/attic-cleanup", __FILE__)
+require File.expand_path("../../lib/attic-cleanup/utility", __FILE__)
+AtticCleanup::Utility.start

data/lib/attic-cleanup.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require "fileutils"
+require "date"
+require "time"
+
+# Check for required gems
+begin
+  require 'thor'
+rescue LoadError
+  puts "Thor is not installed"
+  puts "Run 'gem install thor'"
+  exit 1
+end
+
+# require the classes
+require File.expand_path("../../lib/attic-cleanup/storage/store_files", __FILE__)
+require File.expand_path("../../lib/attic-cleanup/storage/folder_files", __FILE__)
+require File.expand_path("../../lib/attic-cleanup/path/custom", __FILE__)
+require File.expand_path("../../lib/attic-cleanup/log/log", __FILE__)
+require File.expand_path("../../lib/attic-cleanup/initialize/init", __FILE__)
+
+# All the constants and initializers
+module MyAttic
+  ATTIC     = File.join(ENV["HOME"], "MyAttic")
+  TODAY     = File.join(ENV["HOME"], "MyAttic", Date.today.to_s)
+  CUSTOM    = File.join(ENV["HOME"], "MyAttic/custom_paths.txt")
+  DEFAULT   = File.join(ENV["HOME"], "MyAttic/default_path.txt")
+  LOG       = File.join(ENV["HOME"], "MyAttic/log.txt")
+  
+  # Checks if all the folders and files exist, also deletes any empty folders
+  AtticCleanup::Init.check_folder(MyAttic::ATTIC)
+  AtticCleanup::Init.check_folder(MyAttic::TODAY)
+  AtticCleanup::Init.check_file(MyAttic::DEFAULT)
+  AtticCleanup::Init.check_file(MyAttic::CUSTOM)
+  AtticCleanup::Init.clear
+  
+  # This constant is set after the initializers because it reads
+  # the custom_paths.txt file. And it needs to be created first.
+  SHORTCUTS = AtticCleanup::Path::Custom.all(MyAttic::CUSTOM)
+end

data/lib/attic-cleanup/initialize/init.rb

@@ -0,0 +1,51 @@
+module AtticCleanup
+  module Init
+    
+    # Default text for the custom_paths.txt file
+    CUSTOM_FILE   = "#Write all your custom paths here.
+#Or generate them with the 'attic-cleanup new' command
+doc #{File.join(ENV['HOME'], 'Documents')}
+pic #{File.join(ENV['HOME'], 'Pictures')}
+mus #{File.join(ENV['HOME'], 'Music')}
+mov #{File.join(ENV['HOME'], 'Movies')}
+dow #{File.join(ENV['HOME'], 'Downloads')}"
+
+    # Default text for the default_path.txt file
+    DEFAULT_FILE  = "#Write your default location here.
+#{File.join(ENV['HOME'], 'Desktop')}"
+    
+    # Checks if folder exists, if it doesn't it will be created
+    def self.check_folder(value)
+      if !File.directory? value
+        FileUtils.mkdir(value)
+        puts "#{value} doesn't exist yet.\nCreating #{value}.."
+      end
+    end
+    
+    # Checks if file exists, if it doesn't it will be created
+    # and depending on which file, the default text will be set
+    def self.check_file(value)
+      if !File.exist?(value)
+        File.open(value, 'w') do |w| 
+          if value == MyAttic::CUSTOM
+            text = CUSTOM_FILE
+          elsif value == MyAttic::DEFAULT
+            text = DEFAULT_FILE
+          end
+          w.write(text)
+        end
+      end
+    end
+    
+    # Delete all folders in MyAttic that are empty
+    def self.clear
+      attic_folders = Dir.glob(File.join(MyAttic::ATTIC, "*"));
+      attic_folders.each do |f|
+        if f == MyAttic::CUSTOM || f == MyAttic::LOG || f == MyAttic::TODAY || f == MyAttic::DEFAULT
+        elsif Dir[File.join(f, "/*")].empty?
+          FileUtils.rm_rf(f)
+        end
+      end
+    end
+  end
+end

data/lib/attic-cleanup/log/log.rb

@@ -0,0 +1,9 @@
+module AtticCleanup
+  module Log
+    def self.save(file, destination)
+      File.open(MyAttic::LOG, "a") do |w|
+        w.write(file +" >> "+ destination + " || Date: " + Time.now.to_s + "\n")
+      end
+    end
+  end
+end

data/lib/attic-cleanup/path/custom.rb

@@ -0,0 +1,87 @@
+module AtticCleanup
+  module Path
+    class Custom
+      attr_accessor :name, :path, :file, :line_nr
+      
+      # Gets the last line in the default_path.txt file, 
+      # which is the path to the default route
+      def self.default
+        File.open(MyAttic::DEFAULT, 'r') do |r|
+          line_array = []
+          while line = r.gets do
+            line_array << line
+          end
+          line_array.last
+        end
+      end
+      
+      # Selects every line from the selected file
+      # but ignores lines where the first character is '#'
+      def self.all(file)
+        File.open(file, 'r') do |r|
+          line_array = []
+          while line = r.gets do
+            if line[0..0] == "#"
+            else
+              line_array << line
+            end
+          end
+          line_array
+        end
+      end
+    
+      # Gets a specific line from a file
+      def find_line
+        File.open(@file, 'r') do |r|
+          k = []
+          k[0] = nil
+          while line = r.gets do
+            k << line
+          end
+          if k[@line_nr] == nil
+           "This line does not exist."
+          elsif k[@line_nr] == "\n"
+            "Empty"
+          else
+            k[@line_nr]
+          end
+        end
+      end
+      
+      # Gets the custom shortcuts and looks in the custom_paths.txt file
+      # if there is a match. If there is it will select that line and
+      # extract the shortcut, so only the path remains
+      def find_custom
+        File.open(@file, 'r') do |r|
+          k = []
+          k[0] = nil
+          while line = r.gets do
+            name_count = @name.count("A-z, \s")
+            k << line[0..name_count]
+            this_name = k.last
+            
+            if this_name == @name+" "
+              selected_line = line
+              the_name = this_name
+            end
+          end
+          if selected_line == nil
+            puts "Shortcut not found"
+            exit 1
+          else
+            the_name_count = the_name.count("A-z, \s")
+            line_count = selected_line.count("A-z, \s, '/'")
+            selected_line[the_name_count..line_count-1]
+          end
+        end
+      end
+
+      # Write to the custom_paths.txt file
+      def write
+        File.open(@file, 'a') do |w| 
+          w.write("\n"+ @name + " " + @path)
+        end
+      end
+    end
+  end
+end

data/lib/attic-cleanup/storage/folder_files.rb

@@ -0,0 +1,27 @@
+module AtticCleanup
+  module Storage
+    class FolderFiles
+      
+      def all_files
+        @all_files
+      end
+      
+      # Select all files from the selected folder
+      def all_files= ( value )
+        Dir.chdir(value)
+        @all_files = Dir.glob("*");
+      end
+      
+      # Find the file by it's ID
+      def self.find(files, number)
+        current_files = []
+        file_id = 0
+          files.each do |f|
+          current_files[file_id] = f
+          file_id += 1
+        end
+        current_files[number]
+      end
+    end
+  end
+end

data/lib/attic-cleanup/storage/store_files.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+module AtticCleanup
+  module Storage
+    class StoreFiles
+      
+      # Easy method for input
+      def input
+        STDOUT.flush
+        @input = $stdin.gets.chomp
+      end
+
+      def location
+        @location
+      end
+
+      # Sets the location of the store method
+      # If the location wasn't set, the default
+      # location will be used from the default_path.txt file
+      def location= ( value )
+        if value == ""
+          value = AtticCleanup::Path::Custom.default
+        elsif value == "."
+          Dir.chdir(".")
+          value = Dir.getwd()
+          puts Dir.getwd()
+        end
+        @location = value
+      end
+
+      # Checks if the selected path exists
+      def check
+        if !File.directory? @location
+          puts "Invalid path "  + @location
+          exit 1
+        end
+      end
+      
+      # Puts the string of numbers in an array and removes the ','
+      def bundle(input)
+        bundle = input
+        bundle = bundle.scan( /\d+/ )
+        bundle.map!{ |bundle| bundle.to_i }
+        @bundle_items = bundle
+        @bundle_count = bundle.count
+        
+        # If the user typed 'all' instead of numbers, every file will
+        # be set into the the array.
+        if @input == "all"
+          @bundle_items = []
+          p = 0
+          folder_files = AtticCleanup::Storage::FolderFiles.new
+          folder_files.all_files = location
+          folder_files.all_files.each do
+            @bundle_items[p] = p
+            p += 1
+            @bundle_count = "all"
+          end
+        end
+      end
+  
+      
+      def store(a, f)
+        folder_files = AtticCleanup::Storage::FolderFiles.new
+        # Selects all files from the current location
+        folder_files.all_files = location
+        
+        # If option a is nil, the files will have to be selected manually
+        if a == nil
+          i = 1
+          while i == 1
+            # Message with the current location and simple instructions
+            puts "\n"+location
+            puts "Which files do you want to store in your attic?"
+            puts "Type ls for the list of items"
+            puts "Select the items by id. Example: 1,3,5"
+            input()
+        
+            file_id = 0
+            # If input is "all" all the files and folders will be added to the array
+            if @input == "all"
+              @bundle_count = "all"
+              bundle("1")
+              i = 0
+            # If input is "ls" all the files and folder will be shown with their IDs
+            elsif @input == "ls"
+              folder_files.all_files.each do |k|
+                puts file_id.to_s + " - " + AtticCleanup::Storage::FolderFiles.find(folder_files.all_files, file_id)
+                file_id += 1
+              end
+            elsif @input == "exit"
+              exit 1
+            else
+              bundle(@input)
+              i = 0
+            end
+          end
+        else
+          # If option a was selected, all files will be added to the array
+          @bundle_count = "all"
+          @input = "all"
+          bundle(@input)
+        end
+    
+        if f == nil
+          i = 1
+          # If no items were selected, go back to the input
+          if @bundle_count == 0
+            puts "\n\nNo file was selected."
+            store(nil, nil)
+          end
+          while i == 1
+            # If option f was not selected, you will get a warning before moving the files
+            puts "\nAre you sure you want to move #{@bundle_count} files/folders?\n [y/n]"
+            input()
+            if @input == "y"
+              i = 0
+            elsif @input == "n"
+              exit 1
+            else
+              puts "y or n?"
+            end
+          end
+        end
+
+        # Moves each file to the MyAttic folder
+        @bundle_items.each do |b|
+          # If the file wasn't found, print error
+          if AtticCleanup::Storage::FolderFiles.find(folder_files.all_files, b) == nil
+            puts "File ID " + b.to_s + " was not found"
+          else
+            # If file was found move it, print it and record it in the log
+            selected_file = File.join( location, AtticCleanup::Storage::FolderFiles.find(folder_files.all_files, b) )
+            puts "Moving " + selected_file + " to your attic.."
+            AtticCleanup::Log.save(selected_file, MyAttic::TODAY)
+            FileUtils.mv(selected_file, MyAttic::TODAY)
+          end
+        end
+        puts "The files have been moved to " + MyAttic::TODAY
+      end
+    end
+  end
+end

data/lib/attic-cleanup/utility.rb

@@ -0,0 +1,65 @@
+module AtticCleanup
+  class Utility < Thor
+    include Thor::Actions
+
+    desc "store", 
+    "Choose a path or shortcut to store the contents of the given folder.
+    custom paths are called by placing an '@' sign in front of it.
+    example: @mypath
+    
+    -a => 'all'
+    -f => 'force'\n\n"
+    method_options :a => :boolean, :f => :boolean
+    def store(input="")
+      
+      # Checks if the options are set
+      if options[:a]
+        a = true
+      end
+      if options[:f]
+        f = true
+      end
+      
+      # If the input for store has an "@" at the beginning
+      # it's a shortcut.
+      if input[0..0] == "@"
+        c = AtticCleanup::Path::Custom.new
+        # The input without the first character (the @ sign)
+        c.name = input[1..-1]
+        c.file = MyAttic::CUSTOM
+        input = c.find_custom
+      end
+      # The input is the location, if the input had an @ sign
+      # at the beginning, the custom path will be stored in input variable
+      s = AtticCleanup::Storage::StoreFiles.new
+      s.location = input
+      s.check
+      s.store(a, f)
+    end
+
+    desc "new", "Create a custom path.
+    --name => 'Name for your custom path'
+    --path => 'The path for your shortcut'\n\n"
+    method_options :name => :string, :path => :string
+    def new
+      if options[:path] != "path" && options[:path] && options[:name] != "name" && options[:name]
+        c = AtticCleanup::Path::Custom.new
+        # Sets name and path, adds it to the custom_paths.txt file
+        c.name = options[:name]
+        c.path = options[:path]
+        c.file = MyAttic::CUSTOM
+        c.write
+      else
+        puts "Please enter a path and name"
+      end
+    end
+    
+    desc "shortcuts", "View all available shortcuts"
+    # Show all the availible shortcuts from the custom_paths.txt file
+    def shortcuts
+      MyAttic::SHORTCUTS.each do |s|
+        puts s
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: attic-cleanup
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Kevin van Rooijen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70360767219960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360767219960
+description: 
+email: kevin.van.rooijen@gmail.com
+executables:
+- attic-cleanup
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/attic-cleanup
+- lib/attic-cleanup.rb
+- lib/attic-cleanup/utility.rb
+- lib/attic-cleanup/initialize/init.rb
+- lib/attic-cleanup/log/log.rb
+- lib/attic-cleanup/path/custom.rb
+- lib/attic-cleanup/storage/folder_files.rb
+- lib/attic-cleanup/storage/store_files.rb
+homepage: http://rubygems.org/gems/attic-cleanup
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+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.11
+signing_key: 
+specification_version: 3
+summary: attic-cleanup is a gem to easily store your files when you need to get them
+  out of the way.
+test_files: []