desktop-boom 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1ea8bcc636ae95479cbd25a5434628a2f66e225
+  data.tar.gz: 2d1e092e8efa38288166854e3d8d77b64297f66e
+SHA512:
+  metadata.gz: 52cc944f2f63ad16871b5ae9e3251395ab1f99591e0e66b094dc18111f1ddb9f072de4e84381d33011648899e0766beb85f759f0f453a4920e103206af762466
+  data.tar.gz: 38a1921f4d8426205e6a6a5f3bd24a312b950318fab0dfccbfbee98ba6888a80bbc80e5420feb451895304bd9b8d74b45947762aa77f92fb186878229d10746d

data/.gitignore

@@ -0,0 +1,45 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+vendor/Pods/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+## Mac
+.DS_Store
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+tags

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2016, Hwee-Boon Yar
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,46 @@
+About
+---
+The (OS X) desktop is very handy for storing files and folders you are currently working on. `Exposé`/`Mission Control`/`Show Desktop` makes the desktop very accessible. But it can get messy as you work on different tasks.
+
+Enter `boom`. `boom` is a simple tool. You classify your files and folders into "projects" and `boom` helps maintain your OS X desktop by making it contain files and folders for the current project you are working on.
+
+Usage
+---
+A project in `boom` is just a name.
+
+When you switch projects, the files and folders in the desktop will be kept and tagged with the project's name so it can be restored later by boomboom again.
+
+Assuming you are current working on project `A`, to switch to the project called `B`, run
+
+```
+$ boom B
+```
+
+Files and folders in the desktop will be moved away and tagged as belonging to project `A` and the files and folders for project `B` will be moved to the desktop.
+
+If `B` doesn't exist yet, it will be created.
+
+Installation
+---
+`gem install desktop-boom`
+
+Dependencies
+---
+* [commander](https://github.com/tj/commander)
+
+Known Limitations
+---
+These paths are assumed:
+
+* Desktop folder is  `~/Desktop/`
+* Projects folder will be created at `~/Documents/boom/`
+
+License
+---
+BSD
+
+Questions
+---
+* Email: [hboon@motionobj.com](mailto:hboon@motionobj.com)
+* Web: [http://hboon.com/boom/](http://hboon.com/boom/)
+* Twitter: [https://twitter.com/hboon](https://twitter.com/hboon)

data/bin/boom

@@ -0,0 +1,148 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require 'fileutils'
+require 'psych'
+require 'boom'
+
+APP_NAME = 'boom'
+#TODO make configurable?
+DESKTOP_DIR = File.expand_path('~/Desktop/')
+#TODO make configurable?
+PROJECTS_DIRECTORY = "~/Documents/#{APP_NAME}/"
+HELP_STRING = "#{APP_NAME} helps maintain your OS X desktop. Use APP_NAME so that your desktop 
+only contains files and folders for the current project you are 
+working on.
+
+When you switch projects, the files and folders in the desktop will 
+be kept and tagged with the project's name so it can be restored 
+later by #{APP_NAME} again.
+
+Assuming you are current working on project `A`, to switch to the 
+project called `B`, run
+
+  $ APP_NAME B
+
+Files and folders in the desktop will be moved away and tagged as 
+belonging to project `A` and the files and folders for project `B` 
+will be moved to the desktop.
+
+If `B` doesn't exist yet, it will be created.
+
+"
+
+program :version, DesktopBoom::VERSION
+program :description, HELP_STRING
+
+default_command :switch
+
+def config_path
+  File.expand_path("~/.config/#{APP_NAME}.yml")
+end
+
+command :switch do |c|
+  c.syntax = "#{APP_NAME} [switch]"
+  c.summary = 'Switch project'
+  c.description = c.summary
+  c.example 'Run command', "$ #{APP_NAME} <project name>"
+  c.action do |args, options|
+    say_error "Specify the name of the project you want to switch to. If the project 
+doesn't exist, it will be created:
+
+    #{APP_NAME} <project name>
+" and abort if args.empty?
+    new_project = args[0]
+    create_configuration_file unless File.file? config_path
+    File.open(config_path) do |f|
+      mapping = Psych.load(f.read)
+      projects_directory = mapping['projects_directory']
+      current_project = mapping['current_project']
+
+      if new_project == current_project
+        say "Already at project '#{current_project}'"
+        break
+      end
+      move_desktop_to_project(current_project, projects_directory)
+      switch_to(mapping, new_project)
+      move_project_to_desktop(new_project, projects_directory)
+    end
+  end
+end
+
+command :current do |c|
+  c.syntax = "#{APP_NAME} current"
+  c.summary = 'Show the current project name'
+  c.description = c.summary
+  c.example 'Run command', "$ #{APP_NAME} current"
+  c.action do |args, options|
+    create_configuration_file unless File.file? config_path
+    File.open(config_path) do |f|
+      mapping = Psych.load(f.read)
+      projects_directory = mapping['projects_directory']
+      current_project = mapping['current_project']
+      say current_project
+    end
+  end
+end
+
+command :list do |c|
+  c.syntax = "#{APP_NAME} list"
+  c.summary = 'Show list of projects'
+  c.description = c.summary
+  c.example 'Run command', "$ #{APP_NAME} list"
+  c.action do |args, options|
+    create_configuration_file unless File.file? config_path
+    File.open(config_path) do |f|
+      mapping = Psych.load(f.read)
+      projects_directory = mapping['projects_directory']
+      projects = Dir.entries(File.expand_path(projects_directory)).reject {|e| e == '.' || e == '..' || !File.directory?(File.expand_path(e, projects_directory))}
+      current_project = mapping['current_project']
+      projects.each do |e|
+        if e == current_project
+          say "#{e} <="
+        else
+          say e
+        end
+      end
+    end
+  end
+end
+
+def create_configuration_file
+  write_configuration(nil)
+end
+
+def write_configuration(contents)
+  config_dir = File.dirname(config_path)
+  contents ||= {'projects_directory' => PROJECTS_DIRECTORY}
+  FileUtils.mkdir_p(config_dir) unless File.directory? config_dir
+  File.open(config_path, 'w') {|f| f.write(Psych.dump(contents))}
+end
+
+def move_dir_contents(from_dir, to_dir)
+  entries = Dir.entries(from_dir).reject {|e| e == '.' || e == '..'}
+  FileUtils.mkdir_p(to_dir) unless File.directory? to_dir
+  entries.each {|e| FileUtils.mv(File.expand_path(e, from_dir), File.expand_path(e, to_dir))}
+end
+
+def switch_to(mapping, new_project)
+  mapping['current_project'] = new_project
+  write_configuration(mapping)
+end
+
+def move_desktop_to_project(current_project, projects_directory)
+  return unless current_project
+  project_dir = File.expand_path(current_project, projects_directory)
+  move_dir_contents(DESKTOP_DIR, project_dir)
+end
+
+def move_project_to_desktop(new_project, projects_directory)
+  project_dir = File.expand_path(new_project, projects_directory)
+  unless File.directory? project_dir
+    FileUtils.mkdir_p(project_dir) 
+    say "New project created '#{new_project}'"
+  end
+  move_dir_contents(project_dir, DESKTOP_DIR)
+  say "Switched to project '#{new_project}'"
+end

data/boom.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/boom/version.rb', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'desktop-boom'
+  gem.authors  = ['Hwee-Boon Yar']
+  gem.email = 'hboon@motionobj.com'
+  gem.version       = DesktopBoom::VERSION
+
+  gem.licenses      = ['BSD']
+  gem.summary = 'boom - maintain your OS X desktop. Use boom so that your desktop only contains files and folders for the current project you are working on.'
+  gem.description = gem.summary
+  gem.homepage = 'http://hboon.com/boom/'
+
+	gem.add_dependency 'commander', '~> 4.3'
+  gem.files       = `git ls-files`.split($\)
+  gem.executables   = ['boom']
+  gem.require_paths = ['lib']
+  #gem.test_files  = gem.files.grep(%r{^spec/})
+end

data/lib/boom.rb

@@ -0,0 +1,2 @@
+require 'boom/boom'
+require 'boom/version'

data/lib/boom/version.rb

@@ -0,0 +1,3 @@
+module DesktopBoom
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: desktop-boom
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hwee-Boon Yar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: boom - maintain your OS X desktop. Use boom so that your desktop only
+  contains files and folders for the current project you are working on.
+email: hboon@motionobj.com
+executables:
+- boom
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- bin/boom
+- boom.gemspec
+- lib/boom.rb
+- lib/boom/boom.rb
+- lib/boom/version.rb
+homepage: http://hboon.com/boom/
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: boom - maintain your OS X desktop. Use boom so that your desktop only contains
+  files and folders for the current project you are working on.
+test_files: []