ruby-unison 0.0.0 → 0.0.1

data/README.md

@@ -1,24 +1,42 @@
 # ruby-unison
 
 Ruby interface of the command of file synchronizer [unison](http://www.cis.upenn.edu/~bcpierce/unison/).
+ruby-unison defines UnisonCommand class to execute unison in unison.rb.
+
+## Installation
+
+    gem install ruby-unison
 
 ## Examples
 
 ### Basic usage
 
+    require 'unison'
     uc = UnisonCommand.new("pref", "root1", "root2")
     uc.execute
+    
+    uc = UnisonCommand.new("root1", "root2")
+    uc.execute
 
 ### Dry run
 
+    require 'unison'
     uc = UnisonCommand.new("pref", "root1", "root2")
     uc.execute(true)
 
 ### Usage of unison options
 
+    require 'unison'
     uc = UnisonCommand.new("root1", "root2", :force => "root2", :path => ["Document", "Desktop"], :auto => true)
     uc.execute
 
+### Change of unison path
+
+    require 'unison'
+    uc = UnisonCommand.new("root1", "root2")
+    uc.command = "/path/to/unison"
+    uc.execute
+
 ## Contributing to ruby-unison
  
 - Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/unison.rb

@@ -76,19 +76,21 @@ class UnisonCommand
   class InvalidOption < StandardError
   end
 
-  class NonExsistentOption < StandardError
+  class NonExistentOption < StandardError
   end
 
   attr_accessor :profile, :root1, :root2, :option, :command
 
   # +args+ accepts the following three pattern:
-  # - root1, root2, opts = {}
-  # - profilename, opts = {}
-  # - profilename, root1, root2, opts = {}
+  # - root1, root2, opts = \{\}
+  # - profilename, opts = \{\}
+  # - profilename, root1, root2, opts = \{\}
   # We set option of unison command to optinal hash.
   # The keys are symbols made from hypen-removed options of unison command and
   # the values are booleans (true or false), strings, and arrays of strings
   # corresponding to unison's options.
+  # Note that to set boolean option we do not use a string 'true' or 'false',
+  # but we use TrueClass, FalseClass, or NilClass.
   def initialize(*args)
     if Hash === args[-1]
       @option = args[-1]
@@ -122,8 +124,15 @@ class UnisonCommand
       if spec = UNISON_OPTION_SPEC[key.intern]
         case spec
         when :bool
-          if val
-            cmd << "-#{key}"
+          case val
+          when TrueClass, FalseClass, NilClass
+            if val
+              cmd << "-#{key}"
+            else
+              cmd << "-#{key}=false"
+            end
+          else
+            raise UnisonCommand::InvalidOption, "We use TrueClass, FalseClass, or NilClass for #{key}."
           end
         when :array
           k = "-#{key}"
@@ -144,7 +153,7 @@ class UnisonCommand
           cmd << "-#{key}" << v
         end
       else
-        raise UnisonCommand::NonExsistentOption, "Nonexistent unison option: #{key.to_s}"
+        raise UnisonCommand::NonExistentOption, "Nonexistent unison option: #{key.to_s}"
       end
     end
     cmd.compact!

data/ruby-unison.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-unison}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Takayuki YAMAGUCHI"]
+  s.date = %q{2011-05-12}
+  s.description = %q{Ruby interface of the command of file synchronizer unison}
+  s.email = %q{d@ytak.info}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/unison.rb",
+    "ruby-unison.gemspec",
+    "spec/spec_helper.rb",
+    "spec/unison_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/ytaka/ruby-unison}
+  s.licenses = ["GPLv3"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{ruby-unison}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
+      s.add_development_dependency(%q<yard>, [">= 0.6.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.5.0"])
+      s.add_dependency(%q<yard>, [">= 0.6.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.5.0"])
+    s.add_dependency(%q<yard>, [">= 0.6.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/unison_spec.rb

@@ -20,6 +20,11 @@ describe UnisonCommand do
     uc.execute(true).should == ["unison", "pref", "root1", "root2", "-auto"]
   end
 
+  it "should return unison command with a boolean option false" do
+    uc = UnisonCommand.new("pref", "root1", "root2", :auto => false)
+    uc.execute(true).should == ["unison", "pref", "root1", "root2", "-auto=false"]
+  end
+
   it "should return unison command with two arguments and a boolean option" do
     uc = UnisonCommand.new("root1", "root2", :auto => true)
     uc.execute(true).should == ["unison", "root1", "root2", "-auto"]
@@ -51,4 +56,30 @@ describe UnisonCommand do
                                 "-path", "Document", "-path", "Desktop", "-auto"]
   end
 
+  it "should raise UnisonCommand::InvalidOption" do
+    uc = UnisonCommand.new("root1", "root2", :backuplocation => "invalid")
+    lambda do
+      uc.execute
+    end.should raise_error(UnisonCommand::InvalidOption)
+  end
+
+  it "should raise UnisonCommand::InvalidOption" do
+    uc = UnisonCommand.new("root1", "root2", :auto => 'true')
+    lambda do
+      uc.execute
+    end.should raise_error(UnisonCommand::InvalidOption)
+  end
+
+  it "should raise UnisonCommand::NonExistentOption" do
+    uc = UnisonCommand.new("root1", "root2", :autoo => true)
+    lambda do
+      uc.execute
+    end.should raise_error(UnisonCommand::NonExistentOption)
+  end
+
+  it "should change unison path" do
+    uc = UnisonCommand.new("root1", "root2")
+    uc.command = "/usr/local/bin/unison"
+    uc.execute(true).should == ["/usr/local/bin/unison", "root1", "root2"]
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: ruby-unison
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-11 00:00:00 +09:00
+date: 2011-05-12 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,6 +87,7 @@ files:
 - Rakefile
 - VERSION
 - lib/unison.rb
+- ruby-unison.gemspec
 - spec/spec_helper.rb
 - spec/unison_spec.rb
 has_rdoc: true
@@ -103,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2753928633824984509
+      hash: -3840236895340394348
       segments: 
       - 0
       version: "0"