gitdocs 0.4.15 → 0.5.0.pre1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MThmNzE5OWRhMDk2OThhMTdlMmU2MWQ2YzhmY2RkZjUwODM5ZmI0NQ==
+  data.tar.gz: !binary |-
+    NTk2ZDg1ODhiMGNhYzI4NTJjYmU2NWU4ZDM0MDBhMzE4NjQzYWI2Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmY3NzdkYjQ1NzA0MjA0NGY4ZmRkZWE2NGQ2YWM2MTYzNDg0ZjdmYWU4MzJh
+    ODc5YmEyMDI0ZGE2YjY1ZDk4ZDI0MDAzZDg0MWU1YjNiMTAwOTZhOWE5NjNj
+    NWRiNDM4YjVkNTBlOGI2ZGVhZTU4MTFhNTg3MjA5NjZjMWVjZDA=
+  data.tar.gz: !binary |-
+    NDhjOGYxOGMwMzUxMDg5ZWQwZWQwNmVhYWIyOTBiNGZmNjFhNzI1ZGE0Mjkz
+    YjVhODlmNDRlZDIwM2Q4YjJiYWZkYTFkODNmY2IwM2NjOWVjMDYyZjRmOWFh
+    ZWYyMjdlOTBmM2RhNTY2MmQyZjQ4Y2ZhYWViY2JiZDEwNzcwMzM=

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-.DS_Store
+.DS_Store
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG

@@ -1,4 +1,16 @@
-0.4.15 (Unreleased)
+0.5.0.pre1 (11/25/2013)
+
+ * Upgrade thin gem to v1.5.1 (Thanks @acant)
+ * Add TravisCI configuration (Thanks @acant)
+ * Rescue StandardError and better error notifications to fix crashes (@acant)
+ * Reduce unexpected exists caused by repository and file system errors
+ * Add notification of unexpected daemon exist
+ * Add 'open' command to CLI for opening web app (@acant)
+ * Drop support for Ruby 1.8 (@acant)
+ * Code style updates (@acant)
+ * Display file system watch method in status (@acant)
+
+0.4.15 (8/29/2012)
 
   * Adds a 'new directory' function to front-end [thanks Kale Worsley]
   * Change 'New file' function to actually create a blank file [thanks Kale Worsley]

data/README.md

@@ -1,5 +1,8 @@
 # Gitdocs
 
+[![Gem Version](https://badge.fury.io/rb/gitdocs.png)](http://badge.fury.io/rb/gitdocs)
+[![Code Climate](https://codeclimate.com/github/bazaarlabs/gitdocs.png)](https://codeclimate.com/github/bazaarlabs/gitdocs)
+
 Open-source dropbox alternative powered by git. Collaborate on files and tasks without any extra hassle.
 gitdocs will automatically keep everyone's repos in sync by pushing and pulling changes.
 This allows any git repo to be used as a collaborative task list, file share, or wiki for a team.
@@ -43,7 +46,7 @@ synchronized across all gitdocs-enabled clients.
 
 ## Installation
 
-Requires ruby and rubygems. Install as a gem:
+Requires ruby1.9+ and rubygems. Install as a gem:
 
 ```
 gem install gitdocs
@@ -181,12 +184,21 @@ Gitdocs is still a young project with a lot of opportunity for contributions. Pa
 Gitdocs is a fresh project that we originally spiked on in a few days time. Our primary goals are to keep the code as simple as possible,
 but provide the features that makes Dropbox great. If you are interested in other Dropbox alternatives, be sure to checkout our notes below:
 
- * [SparkleShare](http://sparkleshare.org/) is an open source, self-hosted Dropbox alternative written using C# and the [Mono Project](http://www.mono-project.com/Main_Page).
+* [SparkleShare](http://sparkleshare.org/) is an open source, self-hosted Dropbox alternative written using C# and the [Mono Project](http://www.mono-project.com/Main_Page).
    More mature but has a lot of dependencies, and lacks some of the features planned in Gitdocs.
- * [DVCS-Autosync](http://mayrhofer.eu.org/dvcs-autosync) is a project to create an open source replacement for Dropbox based on distributed version control systems.
+* [DVCS-Autosync](http://mayrhofer.eu.org/dvcs-autosync) is a project to create an open source replacement for Dropbox based on distributed version control systems.
    Very similar project but again we have features planned that are out of scope (local tunnel file sharing, complete web ui for browsing, uploading and editing).
- * [Lipsync](https://github.com/philcryer/lipsync) is another similar project. We haven't looked at this too closely, but thought we would mention it in this list.
- * [bitpocket](https://github.com/sickill/bitpocket) is a project that uses rsync to synchronize data. Interesting concept, but
+* [Lipsync](https://github.com/philcryer/lipsync) is another similar project. We haven't looked at this too closely, but thought we would mention it in this list.
+* [bitpocket](https://github.com/sickill/bitpocket) is a project that uses rsync to synchronize data. Interesting concept, but
    lacks revision history, author tracking, etc and we have features planned that are out of scope for this project
+* [RubyDrop](https://github.com/meltingice/RubyDrop) git backed DropBox clone
+* [git-sync](http://tychoish.com/essay/git-sync/) manual git syncing tool,
+  which also use XMPP notifications
+* [git-annex-assistant](http://git-annex.branchable.com/design/assistant/)
+  directory sync tool based on [git-annex](http://git-annex.branchable.com/). (written in Haskel)
+* [BitTorrent Sync](http://www.bittorrent.com/sync) BitTorrent based syncing
+  tool, not open source or publicly defined protocol
+* [StrongSync](https://secure.expandrive.com/strongsync) Dropbox clone utility,
+  proprietary
 
 If any other open-source dropbox alternatives are available, we would love to hear about them so let us know!

data/Rakefile

@@ -6,3 +6,5 @@ Rake::TestTask.new do |t|
   t.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
   t.verbose = true
 end
+
+task :default => [:test]

data/bin/gitdocs

@@ -2,4 +2,4 @@
 
 require 'gitdocs'
 
-Gitdocs::Cli.start(ARGV)
+Gitdocs::Cli.start(ARGV)

data/gitdocs.gemspec

@@ -18,9 +18,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = '>= 1.9'
+
   s.add_dependency 'joshbuddy-guard', '~> 0.10.0'
-  s.add_dependency 'thin', '~> 1.3.1'
-  s.add_dependency 'renee', '~> 0.3.7'
+  s.add_dependency 'thin', '~> 1.5.1'
+  s.add_dependency 'renee', '~> 0.3.11'
   s.add_dependency 'redcarpet', '~> 2.0.0'
   s.add_dependency 'thor', '~> 0.14.6'
   s.add_dependency 'coderay', '~> 1.0.4'
@@ -33,11 +35,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'grit', "~> 2.4.1"
   s.add_dependency 'shell_tools', "~> 0.1.0"
   s.add_dependency 'mimetype-fu', "~> 0.1.2"
-  s.add_dependency 'eventmachine', '>= 1.0.0.beta.3'
-  s.add_dependency 'bigdecimal', '~> 1.1.0'
+  s.add_dependency 'eventmachine', '>= 1.0.3'
+  s.add_dependency 'launchy', '~> 2.4.2'
 
-  s.add_development_dependency 'minitest', "~> 2.6.1"
+  s.add_development_dependency 'minitest', "~> 5.0.8"
   s.add_development_dependency 'rake'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'metric_fu'
 end

data/lib/gitdocs.rb

@@ -15,12 +15,11 @@ require 'gitdocs/docfile'
 require 'gitdocs/rendering'
 
 module Gitdocs
-
   DEBUG = ENV['DEBUG']
 
   # Gitdocs.start(:config_root => "...", :debug => true)
-  def self.start(options={}, &blk)
-    options = { :debug => DEBUG, :config_root => nil }.merge(options)
+  def self.start(options = {}, &blk)
+    options = { debug: DEBUG, config_root: nil }.merge(options)
     @manager.stop if @manager
     @manager = Manager.new(options[:config_root], options[:debug], &blk)
     @manager.start(options[:port])

data/lib/gitdocs/cli.rb

@@ -6,79 +6,101 @@ module Gitdocs
 
     def self.source_root; File.expand_path('../../', __FILE__); end
 
-    desc "start", "Starts a daemonized gitdocs process"
-    method_option :debug, :type => :boolean, :aliases => "-D"
-    method_option :port, :type => :string, :aliases => "-p"
+    desc 'start', 'Starts a daemonized gitdocs process'
+    method_option :debug, type: :boolean, aliases: '-D'
+    method_option :port, type: :string, aliases: '-p'
     def start
-      if self.stopped? && !options[:debug]
-        self.runner.execute { Gitdocs.start(:port => options[:port]) }
-        self.running? ? say("Started gitdocs", :green) : say("Failed to start gitdocs", :red)
-      elsif self.stopped? && options[:debug]
-        say "Starting in debug mode", :yellow
-        Gitdocs.start(:debug => true, :port => options[:port])
-      else # already running
-        say "Gitdocs is already running, please use restart", :red
+      unless stopped?
+        say 'Gitdocs is already running, please use restart', :red
+        return
+      end
+
+      if options[:debug]
+        say 'Starting in debug mode', :yellow
+        Gitdocs.start(debug: true, port: options[:port])
+      else
+        runner.execute { Gitdocs.start(port: options[:port]) }
+        if running?
+          say 'Started gitdocs', :green
+        else
+          say 'Failed to start gitdocs', :red
+        end
       end
     end
 
-    desc "stop", "Stops the gitdocs process"
+    desc 'stop', 'Stops the gitdocs process'
     def stop
-      if self.running?
-        self.runner.execute(:kill => true)
-        say "Stopped gitdocs", :red
-      else # not running
-        say "Gitdocs is not running", :red
+      unless running?
+        say 'Gitdocs is not running', :red
+        return
       end
+
+      runner.execute(kill: true)
+      say 'Stopped gitdocs', :red
     end
 
-    desc "restart", "Restarts the gitdocs process"
+    desc 'restart', 'Restarts the gitdocs process'
     def restart
-      self.stop
-      self.start
+      stop
+      start
     end
 
-    desc "add PATH", "Adds a path to gitdocs"
+    desc 'add PATH', 'Adds a path to gitdocs'
     def add(path)
-      self.config.add_path(path)
+      config.add_path(path)
       say "Added path #{path} to doc list"
-      self.restart if self.running?
+      restart if running?
     end
 
-    desc "rm PATH", "Removes a path from gitdocs"
+    desc 'rm PATH', 'Removes a path from gitdocs'
     def rm(path)
-      self.config.remove_path(path)
+      config.remove_path(path)
       say "Removed path #{path} from doc list"
-      self.restart if self.running?
+      restart if running?
     end
 
-    desc "clear", "Clears all paths from gitdocs"
+    desc 'clear', 'Clears all paths from gitdocs'
     def clear
-      self.config.clear
-      say "Cleared paths from gitdocs"
+      config.clear
+      say 'Cleared paths from gitdocs'
     end
 
-    desc "create PATH REMOTE", "Creates a new gitdoc root based on an existing remote"
+    desc 'create PATH REMOTE', 'Creates a new gitdoc root based on an existing remote'
     def create(path, remote)
       FileUtils.mkdir_p(File.dirname(path))
-      system("git clone -q #{remote} #{ShellTools.escape(path)}") or raise "Unable to clone into #{path}"
-      self.add(path)
+      system("git clone -q #{remote} #{ShellTools.escape(path)}") || fail("Unable to clone into #{path}")
+      add(path)
       say "Created #{path} path for gitdoc"
     end
 
-    desc "status", "Retrieve gitdocs status"
+    desc 'status', 'Retrieve gitdocs status'
     def status
       say "GitDoc v#{VERSION}"
-      say "Running: #{self.running?}"
-      say "Watching paths:"
-      say self.config.shares.map { |s| "  - #{s.path}" }.join("\n")
+      say "Running: #{running?}"
+      say "File System Watch Method: #{file_system_watch_method}"
+      say 'Watching paths:'
+      say config.shares.map { |s| "  - #{s.path}" }.join("\n")
+    end
+
+    desc 'open', 'Open the Web UI'
+    method_option :port, type: :string, aliases: '-p'
+    def open
+      unless running?
+        say 'Gitdocs is not running, cannot open the UI', :red
+        return
+      end
+
+      web_port = options[:port]
+      web_port ||= config.global.web_frontend_port
+      Launchy.open("http://localhost:#{web_port}/")
     end
 
-    desc "config", "Configuration options for gitdocs"
+    desc 'config', 'Configuration options for gitdocs'
     def config
-      # TODO make this work
+      # TODO: make this work
     end
 
-    desc "help", "Prints out the help"
+    desc 'help', 'Prints out the help'
     def help(task = nil, subcommand = false)
       say "\nGitdocs: Collaborate with ease.\n\n"
       task ? self.class.task_help(shell, task) : self.class.help(shell, subcommand)
@@ -86,8 +108,13 @@ module Gitdocs
 
     # Helpers for thor
     no_tasks do
-      def runner(options={})
-        Dante::Runner.new('gitdocs', options.merge(:debug => false, :daemonize => true, :pid_path => self.pid_path))
+      def runner
+        Dante::Runner.new(
+          'gitdocs',
+          debug:     false,
+          daemonize: true,
+          pid_path:  pid_path
+        )
       end
 
       def config
@@ -95,17 +122,34 @@ module Gitdocs
       end
 
       def running?
-        self.runner.daemon_running?
+        runner.daemon_running?
       end
 
       def stopped?
-        self.runner.daemon_stopped?
+        runner.daemon_stopped?
       end
 
       def pid_path
-        "/tmp/gitdocs.pid"
+        '/tmp/gitdocs.pid'
       end
-    end
 
+      # @return [Symbol] to indicate how the file system is being watched
+      def file_system_watch_method
+        if Guard::Listener.mac?
+          begin
+            return :notification if Guard::Listener::Darwin.usable?
+          rescue NameError ; end
+        elsif Guard::Listener.linux?
+          begin
+            return :notification if Guard::Listener::Linux.usable?
+          rescue NameError ; end
+        elsif Guard::Listener.windows?
+          begin
+            return :notification if Guard::Listener::Windows.usable?
+          rescue NameError ; end
+        end
+        :polling
+      end
+    end
   end
 end

data/lib/gitdocs/configuration.rb

@@ -6,14 +6,14 @@ module Gitdocs
     attr_reader :config_root
 
     def initialize(config_root = nil)
-      @config_root = config_root || File.expand_path(".gitdocs", ENV["HOME"])
+      @config_root = config_root || File.expand_path('.gitdocs', ENV['HOME'])
       FileUtils.mkdir_p(@config_root)
       ActiveRecord::Base.establish_connection(
-        :adapter => 'sqlite3',
-        :database => ENV["TEST"] ? ':memory:' : File.join(@config_root, 'config.db')
+        adapter: 'sqlite3',
+        database: ENV['TEST'] ? ':memory:' : File.join(@config_root, 'config.db')
       )
-      ActiveRecord::Migrator.migrate(File.expand_path("../migration", __FILE__))
-      import_old_shares unless ENV["TEST"]
+      ActiveRecord::Migrator.migrate(File.expand_path('../migration', __FILE__))
+      import_old_shares unless ENV['TEST']
     end
 
     class Share < ActiveRecord::Base
@@ -21,14 +21,14 @@ module Gitdocs
 
       def available_remotes
         repo = Grit::Repo.new(path)
-        repo.remotes.map{|r| r.name}
+        repo.remotes.map { |r| r.name }
       rescue
         nil
       end
 
       def available_branches
         repo = Grit::Repo.new(path)
-        repo.heads.map{|r| r.name}
+        repo.heads.map { |r| r.name }
       rescue
         nil
       end
@@ -39,15 +39,15 @@ module Gitdocs
     end
 
     def add_path(path, opts = nil)
-      path = self.normalize_path(path)
-      path_opts = {:path => path}
+      path = normalize_path(path)
+      path_opts = { path: path }
       path_opts.merge!(opts) if opts
       Share.new(path_opts).save!
     end
 
     def remove_path(path)
-      path = self.normalize_path(path)
-      Share.where(:path => path).destroy_all
+      path = normalize_path(path)
+      Share.where(path: path).destroy_all
     end
 
     def clear
@@ -59,7 +59,7 @@ module Gitdocs
     end
 
     def global
-      raise if Config.all.size > 1
+      fail if Config.all.size > 1
       Config.create! if Config.all.empty?
       Config.all.first
     end
@@ -69,6 +69,7 @@ module Gitdocs
     end
 
     private
+
     def import_old_shares
       full_path = File.expand_path('paths', config_root)
       if File.exist?(full_path)

data/lib/gitdocs/docfile.rb

@@ -20,4 +20,4 @@ module Gitdocs
       File.directory?(@path)
     end
   end
-end
+end

data/lib/gitdocs/manager.rb

@@ -23,59 +23,54 @@ module Gitdocs
       results
     end
 
-    def start(web_port=nil)
-      self.log "Starting Gitdocs v#{VERSION}..."
-      self.log "Using configuration root: '#{self.config.config_root}'"
-      self.log "Shares: #{config.shares.map(&:inspect).join(", ")}"
-      # Start the repo watchers
-      runners = nil
-      retrying = false
+    def start(web_port = nil)
+      log("Starting Gitdocs v#{VERSION}...")
+      log("Using configuration root: '#{config.config_root}'")
+      log("Shares: (#{config.shares.length}) #{config.shares.map(&:inspect).join(', ')}")
+
+      restarting = false
       begin
         EM.run do
-          self.log "Starting EM loop..."
-          @runners = config.shares.map { |share|
-            self.log "Starting #{share}"
-            Runner.new(share)
-          }
-          self.log "Running runners... #{@runners.size}"
-          @runners.each(&:run)
+          log('Starting EM loop...')
+
+          @runners = Runner.start_all(config.shares)
+
           # Start the web front-end
-          if self.config.global.start_web_frontend
-            web_port ||= self.config.global.web_frontend_port
-            Server.new(self, *@runners).start(web_port.to_i)
-            EM.defer( proc {
-              i = 0
-              web_started = false
-              begin
-                TCPSocket.open('127.0.0.1', web_port.to_i).close
-                web_started = true
-              rescue Errno::ECONNREFUSED
-                self.log "Retrying server loop..."
-                sleep 0.2
-                i += 1
-                retry if i <= 20
-              end
-              system("open http://localhost:#{web_port}/") if !retrying && self.config.global.load_browser_on_startup && web_started
-            }, proc {
-              self.log "Web server running!"
-            })
+          if config.global.start_web_frontend
+            web_port ||= config.global.web_frontend_port
+            web_server = Server.new(self, web_port, *@runners)
+            web_server.start
+            web_server.wait_for_start_and_open(restarting)
           end
         end
       rescue Restart
-        retrying = true
+        restarting = true
         retry
       end
     rescue Exception => e # Report all errors in log
-      self.log(e.class.inspect + " - " + e.inspect + " - " + e.message.inspect, :error)
-      self.log(e.backtrace.join("\n"), :error)
+      log(e.class.inspect + ' - ' + e.inspect + ' - ' + e.message.inspect, :error)
+      log(e.backtrace.join("\n"), :error)
+
+      # HACK: duplicating the error notification code from the Runner
+      begin
+        title = 'Unexpected exit'
+        msg   = 'Something went wrong. Please see the log for details.'
+
+        Guard::Notifier.notify(msg, title: title, image: :failure)
+        Kernel.warn("#{title}: #{msg}")
+      rescue
+        # do nothing, This contain any exceptions which might be thrown by
+        # the notification.
+      end
+
       raise
     ensure
-      self.log("Gitdocs is terminating...goodbye\n\n")
+      log("Gitdocs is terminating...goodbye\n\n")
     end
 
     def restart
       Thread.new do
-        Thread.main.raise Restart, "restarting ... "
+        Thread.main.raise Restart, 'restarting ... '
         sleep 0.1 while EM.reactor_running?
         start
       end
@@ -85,12 +80,10 @@ module Gitdocs
       EM.stop
     end
 
-    protected
-
     # Logs and outputs to file or stdout based on debugging state
     # log("message")
-    def log(msg, level=:info)
+    def log(msg, level = :info)
       @debug ? puts(msg) : @logger.send(level, msg)
     end
   end
-end
+end