tag 0.1.0 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,2 +1,5 @@
-= 0.1.0
+== 0.2.0
+* Add models (tagging for multiple objects or apps)
+
+== 0.1.0
 * Something works!

data/README.md

@@ -8,13 +8,28 @@ In making tags a first class nix citizen, perhaps they will see the light of day
 Examples
 ========
 
-    $ tag add horse animal
-    $ tag add cat animal
-    $ tag list animal
+Let's start with tagging animals:
+
+    $ tag add horse -t fast strong
+    $ tag add cat -t fast independent
+    $ tag add dog -t loving
+    $ tag list fast
     horse
     cat
 
-    # TODO
+Tired of animals, let's tag cities. To avoid interfering with
+the animals list, we'll use a cities model:
+
+    $ tag add nyc -t fast fun -m cities
+    $ tag add boston -t educated clean -m cities
+    $ tag add paris -t awesome delicious
+    $ tag list fast -m cities
+    nyc
+    # to avoid typing '-m cities' for every command
+    $ export TAG_MODEL=cities
+
+Since models are isolated from one another, third party commandline apps can
+use tag for their own private tagging purposes.
 
 Motivation
 ==========
@@ -29,7 +44,6 @@ Contributing
 Todo
 ====
 
-* Tests!
 * Several more tag actions
 * Description and time fields
 * Make storage agnostic

data/lib/tag.rb

@@ -1,88 +1,17 @@
-require 'yaml'
-require 'thor'
+require 'tag/runner'
+require 'fileutils'
+require 'tag/store'
 
 module Tag
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 
-  class Store
-    class << self; attr_accessor :file; end
-    self.file = Dir.home + '/.tagrc'
-
-    def initialize
-      @file = self.class.file
-      @hash = File.exists?(@file) ? YAML.load_file(@file) : {}
-    end
-
-    def save
-      File.open(@file, 'w') {|f| f.write(@hash.to_yaml) }
-    end
-
-    def tag(item, tag)
-      @hash[tag] ||= []
-      @hash[tag] << item
-      save
-    end
-
-    def remove_tag(item, tag)
-      @hash[tag] ||= []
-      @hash[tag].delete item
-      save
-    end
-
-    def list(tag)
-      @hash[tag] ||= []
-      @hash[tag]
-    end
-
-    def list_tags
-      @hash.keys.sort
-    end
-
-    def tree
-      list_tags.map {|tag|
-        ["#{tag}", list(tag).map {|t| "    #{t}" }]
-      }.flatten
-    end
-
-    def delete_tags(*tags)
-      tags.each {|tag| @hash.delete(tag) }
-      save
-    end
+  def self.store(model = nil)
+    @store ||= Store.new(model)
   end
 
-  def self.store
-    @store ||= Store.new
-  end
-
-  class Runner < Thor
-    desc "add ITEM TAG", 'tag an item'
-    def add(item, tag)
-      Tag.store.tag(item, tag)
-    end
-
-    desc "rm ITEM TAG", 'remove tag from item'
-    def rm(item, tag)
-      Tag.store.remove_tag(item, tag)
-    end
-
-    desc "list TAG", 'list items by tag'
-    def list(tag)
-      puts Tag.store.list(tag)
-    end
-
-    method_option :rm, :type => :boolean, :desc => 'remove tags'
-    desc "tags", 'list or remove tags'
-    def tags(*args)
-      if options[:rm]
-        Tag.store.delete_tags(*args)
-      else
-        puts Tag.store.list_tags
-      end
-    end
-
-    desc "tree", 'print tags with their items underneath them'
-    def tree
-      puts Tag.store.tree
+  def self.home
+    @home ||= (ENV['TAG_HOME'] || File.join(Dir.home, '.tag')).tap do |dir|
+      FileUtils.mkdir_p(dir)
     end
   end
 end

data/lib/tag/runner.rb

@@ -0,0 +1,51 @@
+require 'thor'
+
+module Tag
+  class Runner < Thor
+    def self.model_option
+      method_option :model, :type => :string, :aliases => '-m'
+    end
+
+    model_option
+    method_option :tags, :type => :array, :required => true, :aliases => '-t'
+    desc "add *ITEMS -t *TAGS", 'add tag(s) to item(s)'
+    def add(*items)
+      Tag.store(options[:model]).multi_tag(items, options[:tags])
+    end
+
+    model_option
+    method_option :tags, :type => :array, :required => true, :aliases => '-t'
+    desc "rm *ITEMS -t *TAGS", 'remove tag(s) from item(s)'
+    def rm(*items)
+      Tag.store(options[:model]).multi_remove_tag(items, options[:tags])
+    end
+
+    model_option
+    desc "list TAG", 'list items by tag'
+    def list(tag)
+      puts Tag.store(options[:model]).list(tag)
+    end
+
+    model_option
+    method_option :rm, :type => :boolean, :desc => 'remove tags'
+    desc "tags", 'list or remove tags'
+    def tags(*args)
+      if options[:rm]
+        Tag.store(options[:model]).delete_tags(*args)
+      else
+        puts Tag.store(options[:model]).list_tags
+      end
+    end
+
+    model_option
+    desc "tree", 'print tags with their items underneath them'
+    def tree
+      puts Tag.store(options[:model]).tree
+    end
+
+    desc "models", 'list models'
+    def models
+      puts Tag::Store.models
+    end
+  end
+end

data/lib/tag/store.rb

@@ -0,0 +1,68 @@
+require 'yaml'
+
+module Tag
+  class Store
+
+    def self.models
+      Dir["#{Tag.home}/*.yml"].map {|file| file[%r{([^/]+).yml$}, 1] }.sort
+    end
+
+    def initialize(model = nil)
+      model ||= ENV['TAG_MODEL'] || 'default'
+      @file = File.join(Tag.home, "#{model}.yml")
+      @hash = File.exists?(@file) ? YAML.load_file(@file) : {}
+    end
+
+    def save
+      File.open(@file, 'w') {|f| f.write(@hash.to_yaml) }
+    end
+
+    def tag(item, tag)
+      @hash[tag] ||= []
+      @hash[tag] << item
+    end
+
+    def multi_tag(items, tags)
+      tags.each do |tag|
+        items.each do |item|
+          tag(item, tag)
+        end
+      end
+      save
+    end
+
+    def multi_remove_tag(items, tags)
+      tags.each do |tag|
+        items.each do |item|
+          remove_tag(item, tag)
+        end
+      end
+      save
+    end
+
+    def remove_tag(item, tag)
+      @hash[tag] ||= []
+      @hash[tag].delete item
+    end
+
+    def list(tag)
+      @hash[tag] ||= []
+      @hash[tag]
+    end
+
+    def list_tags
+      @hash.keys.sort
+    end
+
+    def tree
+      list_tags.map {|tag|
+        ["#{tag}", list(tag).map {|t| "    #{t}" }]
+      }.flatten
+    end
+
+    def delete_tags(*tags)
+      tags.each {|tag| @hash.delete(tag) }
+      save
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,25 @@
+gem 'minitest' unless ENV['NO_RUBYGEMS']
+require 'minitest/autorun'
+require 'tag'
+require 'open3'
+require 'fileutils'
+
+ENV['TAG_HOME'] = File.dirname(__FILE__) + '/.tag'
+
+module TestHelpers
+  attr_reader :stdout, :stderr, :process
+
+  def tag(cmd)
+    args = cmd.split(/\s+/)
+    args.unshift File.dirname(__FILE__) + '/../bin/tag'
+    args.unshift({'RUBYLIB' => "#{File.dirname(__FILE__)}/../lib:" +
+                 ENV['RUBYLIB']})
+    @stdout, @stderr, @process = Open3.capture3(*args)
+  end
+end
+
+class MiniTest::Unit::TestCase
+  include TestHelpers
+end
+
+MiniTest::Unit.after_tests { FileUtils.rm_rf(ENV['TAG_HOME']) }

data/spec/runner_spec.rb

@@ -0,0 +1,122 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+describe Tag::Runner do
+  def tagged(tag)
+    tag "list #{tag}"
+    stdout.split("\n")
+  end
+
+  before { FileUtils.rm_rf(ENV['TAG_HOME']) }
+
+  describe "add" do
+    it "adds a tag" do
+      tag 'add feynman -t physicist'
+      tagged('physicist').must_equal ["feynman"]
+    end
+
+    it "adds two tags" do
+      tag 'add feynman -t physicist teacher'
+      tagged('physicist').must_equal ["feynman"]
+      tagged('physicist').must_equal ["feynman"]
+    end
+
+    it "adds a tag to two items" do
+      tag 'add feynman fermi -t physicist'
+      tagged('physicist').must_equal %w{feynman fermi}
+    end
+
+    it "fails if no tag given" do
+      tag 'add um'
+      stderr.must_include 'required option'
+    end
+
+    it "with model option adds to a different model" do
+      tag 'add feynman -t physicist -m physics'
+      tagged('physicist -m physics').must_equal ['feynman']
+      tagged('physicist').must_equal []
+    end
+
+    it "with $TAG_MODEL adds to a different model" do
+      ENV['TAG_MODEL'] = 'physica'
+      tag 'add feynman -t physicist'
+      tagged('physicist').must_equal ['feynman']
+      tagged('physicist -m default').must_equal []
+      ENV['TAG_MODEL'] = nil
+    end
+  end
+
+  describe "rm" do
+    it "removes a tag" do
+      tag 'add newton -t physicist fig'
+      tag 'rm newton -t fig'
+      tagged('physicist').must_equal ['newton']
+      tagged('fig').must_equal []
+    end
+
+    it "removes two tags" do
+      tag 'add newton -t physicist fig sir'
+      tag 'rm newton -t fig sir'
+      tagged('physicist').must_equal ['newton']
+      tagged('fig').must_equal []
+      tagged('sir').must_equal []
+    end
+
+    it "removes two items from a tag" do
+      tag 'add newton -t physicist fig'
+      tag 'add tree -t fig'
+      tag 'rm newton tree -t fig'
+      tagged('fig').must_equal []
+    end
+
+    it "fails if no tag given" do
+      tag 'rm um'
+      stderr.must_include 'required option'
+    end
+
+    it "with model option removes a tag from other model" do
+      tag 'add newton -t physicist fig -m physics'
+      tag 'rm newton -t fig -m physics'
+      tagged('physicist -m physics').must_equal ['newton']
+      tagged('physicist').must_equal []
+    end
+  end
+
+  describe "tags" do
+    it "by default lists all tags" do
+      tag 'add fermi -t italian german irish'
+      tag 'tags'
+      stdout.split("\n").must_equal %w{german irish italian}
+    end
+
+    it "with model option lists all tags for another model" do
+      tag 'add fermi -t italian german irish -m physicist'
+      tag 'tags -m physicist'
+      stdout.split("\n").must_equal %w{german irish italian}
+      tag 'tags'
+      stdout.split("\n").must_equal []
+    end
+
+    it "with rm option deletes tags" do
+      tag 'add fermi -t italian german irish'
+      tag 'add davinci -t italian german irish'
+      tag 'tags german irish --rm'
+      tagged('german').must_equal []
+      tagged('irish').must_equal []
+    end
+  end
+
+  it "tree prints tree" do
+    tag 'add child -t parent1 parent2'
+    tag 'tree'
+    stdout.chomp.must_equal [
+      'parent1', '    child', 'parent2', '    child'
+    ].join("\n")
+  end
+
+  it "models prints list of models" do
+    tag 'add feynman -t funny -m physicist'
+    tag 'add cat -t independent'
+    tag 'models'
+    stdout.split("\n").must_equal ['default', 'physicist']
+  end
+end

metadata

@@ -1,40 +1,44 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tag
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Gabriel Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-12 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152084180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.14.6
   type: :runtime
-  version_requirements: *id001
-description: This project lets you tag anything from the commandline. The `tag` executable provides a consistent way to add, remove and modify tags for tagged items. The goal is to make tagging dead simple and usable by other commandline apps. In making tags a first class nix citizen, perhaps they will see the light of day.
+  prerelease: false
+  version_requirements: *2152084180
+description: This project lets you tag anything from the commandline. The `tag` executable
+  provides a consistent way to add, remove and modify tags for tagged items. The goal
+  is to make tagging dead simple and usable by other commandline apps. In making tags
+  a first class nix citizen, perhaps they will see the light of day.
 email: gabriel.horner@gmail.com
-executables: 
+executables:
 - tag
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - LICENSE.txt
-files: 
+files:
+- lib/tag/runner.rb
+- lib/tag/store.rb
 - lib/tag.rb
+- spec/helper.rb
+- spec/runner_spec.rb
 - bin/tag
 - LICENSE.txt
 - CHANGELOG.rdoc
@@ -42,33 +46,29 @@ files:
 - deps.rip
 - Rakefile
 - .gemspec
-has_rdoc: true
 homepage: http://github.com/cldwalker/tag
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: tag anything from the commandline
 test_files: []
-