micktagger 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+*.swp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    micktagger (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  micktagger!
+  rspec

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2012 Thorsten Ball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# MickTagger
+
+MickTagger is a command line utility that allows you to tag files.
+
+It only uses JSON file placed in your home directory as `.micktagger.json` to
+save those file and tags associations.
+
+## Usage & Examples
+
+```
+$ mt -a important Gemfile
+$ mt -l important
+/Users/mrnugget/code/micktagger/Gemfile
+$ mt -a to_be_deleted ~/tmp/git_testing
+$ mt -a to_be_deleted ~/tmp/install.zip
+$ mt -l to_be_deleted
+/Users/mrnugget/tmp/git_testing
+/Users/mrnugget/tmp/install.zip
+$ mt -d to_be_deleted ~/tmp/install.zip
+$ mt -l to_be_deleted
+/Users/mrnugget/tmp/git_testing
+```
+
+## Installation
+
+`gem install micktagger`
+
+## License
+
+MickTagger is released under the MIT license:
+
+- www.opensource.org/licenses/MIT

data/bin/mt

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'micktagger'
+
+MickTagger::CLI.dance!

data/lib/micktagger/cli.rb

@@ -0,0 +1,42 @@
+module MickTagger
+  class CLI
+    def self.dance!
+      dotfile_handler = DotfileHandler.new
+      parser          = OptionParser.new
+
+      params          = {}
+      output_lines    = []
+
+      parser.on('-a', '--add [TAG]', String) do |tag|
+        params[:action] = :add
+        params[:tag]    = tag
+      end
+
+      parser.on('-d', '--delete [TAG]', String) do |tag|
+        params[:action] = :delete
+        params[:tag]    = tag
+      end
+
+      parser.on('-l', '--list [TAG]', String) do |tag|
+        params[:action] = :list
+        params[:tag]    = tag
+      end
+
+      files = parser.parse!
+      files.map! {|file| File.expand_path(file) }
+
+      case params[:action]
+      when :add
+        files.each { |file| dotfile_handler.add_tag_to(file, params[:tag]) }
+      when :delete
+        files.each { |file| dotfile_handler.remove_tag_from(file, params[:tag]) }
+      when :list
+        output_lines << dotfile_handler.files_for(params[:tag])
+      end
+
+      dotfile_handler.save_file!
+
+      output_lines.each { |line| $stdout.puts(line) }
+    end
+  end
+end

data/lib/micktagger/dotfile_handler.rb

@@ -0,0 +1,38 @@
+module MickTagger
+  class DotfileHandler
+    def initialize
+      @file_path = "#{ENV['HOME']}/.micktagger.json"
+      @content   = load_content(@file_path)
+    end
+
+    def add_tag_to(file, tag)
+      @content[file] = [] unless @content[file]
+      @content[file] << tag
+      @content[file].uniq!
+    end
+
+    def remove_tag_from(file, tag)
+      @content[file].delete(tag)
+      @content.delete(file) if @content[file].empty?
+    end
+
+    def save_file!
+      File.open(@file_path, 'w') { |dotfile| dotfile.write(@content.to_json) }
+    end
+
+    def files_for(tag)
+      @content.select { |file, tags| tags.include?(tag) }.keys
+    end
+
+    private
+
+      def load_content(path)
+        File.exists?(path) ? bootstrap_content(path) : {}
+      end
+
+      def bootstrap_content(path)
+        existing_content = File.read(path)
+        existing_content.empty? ? {} : JSON.parse(existing_content)
+      end
+  end
+end

data/lib/micktagger/version.rb

@@ -0,0 +1,3 @@
+module MickTagger
+  VERSION = "0.1.0"
+end

data/lib/micktagger.rb

@@ -0,0 +1,8 @@
+require 'optparse'
+require 'json'
+require 'micktagger/dotfile_handler'
+require 'micktagger/cli'
+require 'micktagger/version'
+
+module MickTagger
+end

data/micktagger.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/micktagger/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thorsten Ball"]
+  gem.email         = ["mrnugget@gmail.com"]
+  gem.description   = %q{MickTagger is a command line utility that allows you to tag files.}
+  gem.summary       = %q{
+    With MickTagger you can tag files, list files tagged with a specified tag,
+    remove tags and do cool stuff — all on the command line!
+    It only needs a small json dotfile in your homedirectory to save that information.
+  }
+  gem.homepage      = "http://www.github.com/mrnugget/micktagger"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "micktagger"
+  gem.require_paths = ["lib"]
+  gem.version       = MickTagger::VERSION
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/integration/mt_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'micktagger command line interface' do
+  it 'allows me to add tags to a file, list the files of for tag and remove tags' do
+    readme_full_path = File.expand_path('../../../README.md', __FILE__)
+
+    `mt -a important README.md`
+
+    dotfile = read_and_parse_fake_dotfile
+    dotfile[readme_full_path].should == ['important']
+
+    output = `mt -l important`
+    output.should match(readme_full_path)
+
+    `mt -a markdown README.md`
+
+    dotfile = read_and_parse_fake_dotfile
+    dotfile[readme_full_path].should include('important')
+    dotfile[readme_full_path].should include('markdown')
+
+    `mt -d important README.md`
+
+    dotfile = read_and_parse_fake_dotfile
+    dotfile[readme_full_path].should_not include('important')
+
+    `mt -d markdown README.md`
+
+    dotfile = read_and_parse_fake_dotfile
+    dotfile.should_not include(readme_full_path)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'micktagger'
+
+Dir[File.expand_path(File.dirname(__FILE__) + '/support/**/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:each) do
+    setup_test_env
+    delete_fake_dotfile
+  end
+
+  config.after(:each) do
+    delete_fake_dotfile
+  end
+end

data/spec/support/dotfile_helpers.rb

@@ -0,0 +1,11 @@
+def fake_dotfile
+  File.expand_path('../../fixtures/fake_home/.micktagger.json', __FILE__)
+end
+
+def delete_fake_dotfile
+  File.delete(fake_dotfile) if File.exists?(fake_dotfile)
+end
+
+def read_and_parse_fake_dotfile
+  JSON.parse(File.read(fake_dotfile))
+end

data/spec/support/env_helpers.rb

@@ -0,0 +1,6 @@
+def setup_test_env
+  # Modifying the PATH to prioritize the current executable
+  ENV['PATH'] = "#{File.expand_path('../../../bin/', __FILE__)}:#{ENV['PATH']}"
+  # Modifying HOME to test the micktagger dotfile
+  ENV['HOME'] = File.expand_path('../../fixtures/fake_home/', __FILE__)
+end

data/spec/unit/dotfile_handler_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe MickTagger::DotfileHandler do
+  let(:handler) do
+    MickTagger::DotfileHandler.new
+  end
+
+  describe '#add_tag_to' do
+    it 'allows me to add a tag to a file' do
+      handler.add_tag_to('/Users/mrnugget/todo.txt', 'important')
+      handler.save_file!
+
+      dotfile = read_and_parse_fake_dotfile
+      dotfile['/Users/mrnugget/todo.txt'].should == ['important']
+    end
+
+    it 'allows me to add several tags to a file' do
+      handler.add_tag_to('/Users/mrnugget/readme.md', 'markdown')
+      handler.add_tag_to('/Users/mrnugget/readme.md', 'important')
+      handler.save_file!
+
+      dotfile = read_and_parse_fake_dotfile
+      dotfile['/Users/mrnugget/readme.md'].should == ['markdown', 'important']
+    end
+
+    it 'does not keep duplicate tags in the file' do
+      handler.add_tag_to('/Users/mrnugget/todo.txt', 'important')
+      handler.add_tag_to('/Users/mrnugget/todo.txt', 'important')
+      handler.save_file!
+
+      dotfile = read_and_parse_fake_dotfile
+      dotfile['/Users/mrnugget/todo.txt'].should == ['important']
+    end
+  end
+
+  describe '#remove_tag_from' do
+    before(:each) do
+      handler.add_tag_to('/Users/mrnugget/todo.txt', 'important')
+      handler.add_tag_to('/Users/mrnugget/readme.md', 'markdown')
+      handler.add_tag_to('/Users/mrnugget/readme.md', 'important')
+      handler.save_file!
+    end
+
+    it 'allows me to remove tags from a file' do
+      handler.remove_tag_from('/Users/mrnugget/readme.md', 'markdown')
+      handler.save_file!
+
+      dotfile = read_and_parse_fake_dotfile
+      dotfile['/Users/mrnugget/readme.md'].should_not include('markdown')
+    end
+
+    it 'removes files from dotfile if they have not tags' do
+      handler.remove_tag_from('/Users/mrnugget/todo.txt', 'important')
+      handler.save_file!
+
+      dotfile = read_and_parse_fake_dotfile
+      dotfile.should_not include('/Users/mrnugget/todo.txt')
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: micktagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Thorsten Ball
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: MickTagger is a command line utility that allows you to tag files.
+email:
+- mrnugget@gmail.com
+executables:
+- mt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/mt
+- empty.yaml
+- lib/micktagger.rb
+- lib/micktagger/cli.rb
+- lib/micktagger/dotfile_handler.rb
+- lib/micktagger/version.rb
+- micktagger.gemspec
+- spec/integration/mt_spec.rb
+- spec/spec_helper.rb
+- spec/support/dotfile_helpers.rb
+- spec/support/env_helpers.rb
+- spec/unit/dotfile_handler_spec.rb
+homepage: http://www.github.com/mrnugget/micktagger
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: With MickTagger you can tag files, list files tagged with a specified tag,
+  remove tags and do cool stuff — all on the command line! It only needs a small json
+  dotfile in your homedirectory to save that information.
+test_files:
+- spec/integration/mt_spec.rb
+- spec/spec_helper.rb
+- spec/support/dotfile_helpers.rb
+- spec/support/env_helpers.rb
+- spec/unit/dotfile_handler_spec.rb