siuying-gitdocs 0.4.14.md

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/CHANGELOG

@@ -0,0 +1,79 @@
+0.4.15 (Unreleased)
+
+  * Adds a 'new directory' function to front-end [thanks Kale Worsley]
+  * Change 'New file' function to actually create a blank file [thanks Kale Worsley]
+
+0.4.14 (1/14/2012)
+
+  * Change file modes into tab style [thanks Kale Worsley]
+  * Add ability to revert a file to a previous revision  [thanks Kale Worsley]
+  * Add optional git commit message field to edit form [thanks Kale Worsley]
+
+0.4.13 (1/11/2012)
+
+  * Redirect to first share if there's only one
+  * Render inline README for a directory
+  * Front-end now lists folder sizes in directory listing [Thanks evan tatarka]
+
+0.4.12 (1/05/2012)
+
+  * Fixes incorrect padding style on rendered code blocks (thanks chris kempson)
+  * Fixes encoding issues in markdown files
+  * Tag documents as utf-8 in meta for web frontend (thanks chris kempson)
+
+0.4.11 (1/04/2012)
+
+  * Add line-height to code blocks in file displays
+  * Fixes various browser inconsistencies (thanks evan tatarka)
+
+0.4.10 (12/30/2011)
+
+  * View revision history on the web front-end!
+
+0.4.9 (12/30/2011)
+
+  * Adds configuration for web port in settings
+  * Adds support for 'add' and 'remove' shares in settings
+
+0.4.8 (12/29/2011)
+
+  * Only encode to utf-8 on ruby 1.9.x
+  * Fixes so that settings form on the web front-end saves
+  * Cleanup the front-end directory listing significantly
+  * More robust EM reactor loop handling
+
+0.4.7 (12/15/2011)
+
+  * Re-throw exceptions from reactor loop
+  * Socket testing moved to defer block
+
+0.4.5, 0.4.6 (12/14/2011)
+
+  * Enables logs in ~/.gitdocs/log for easier debugging
+  * Fix issue with default sort order on web interface
+  * Fixes major mime type detection issues
+  * Fixes rendering issues
+
+0.4.4 (12/14/2011)
+
+  * Lock to eventmachine 1.0
+  * Use mime-types over file for better platform support
+  * Remove signal handling and just leverage EM start/stop
+  * Adds table sorting and file+folder icons in web front-end
+
+0.4.3 (12/13/2011)
+
+  * Javascript fixes for front-end
+
+0.4.2 (12/13/2011)
+
+  * Fixes search on blank results case
+
+0.4.1 (12/13/2011)
+
+  * Adds a basic search to web front-end
+  * Beginning of the work towards cross-platform notifications
+
+
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gitdocs.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 GoMiso, Inc
+
+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,192 @@
+# 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.
+Supports a web front-end allowing each repo to be accessed through your browser.
+
+**Note:** Gitdocs has been tested on multiple unix systems including Mac OS X and Ubuntu.
+Windows support is [half-baked](https://github.com/bazaarlabs/gitdocs/issues/7)
+but we plan to tackle that shortly in an upcoming release.
+
+## Why?
+
+Why use gitdocs for your file and doc sharing needs?
+
+ * **Open** - gitdocs is entirely open-source under the MIT license
+ * **Simple** - gitdocs is the simplest thing that works in both setup and usage
+ * **Secure** - gitdocs leverages git (and existing providers like github) to store your data safely.
+ * **Versatile** - share task lists, code snippets, images, files or just use it as a wiki (with our web front-end).
+ * **Portable** - access your files on any client that can use git.
+
+The best part is that getting started using this project is quick and simple.
+
+## Quick Start
+
+Gitdocs monitors any number of directories for changes and keeps them automatically synced. You can either add
+existing git directories to be watched or have gitdocs pull down a repository for you.
+
+There are plenty of great git hosting providers to safely store your data and you can trust the data is stored securely.
+If you want a private repo to use with gitdocs, we recommend you check out [BitBucket](https://bitbucket.org/) which
+provides free private git repos after registration.
+
+To get started with gitdocs and a secure private bitbucket repo:
+
+ - `gem install gitdocs`
+ - `gitdocs start`
+ - Login to [BitBucket](https://bitbucket.org/) and add a new private repo named 'docs'
+ - Setup your SSH Key under [Account](https://bitbucket.org/account/) for ssh access
+ - `gitdocs create ~/Documents/gitdocs git@bitbucket.org:username/docs.git`
+
+There you go! Now just start adding and editing files within the directory and they will be automatically
+synchronized across all gitdocs-enabled clients.
+
+## Installation
+
+Requires ruby and rubygems. Install as a gem:
+
+```
+gem install gitdocs
+```
+
+If you have Growl installed on Max OSX, you'll probably want to run:
+
+```
+brew install growlnotify
+```
+
+to enable Growl notification support.
+
+## Usage
+
+### Starting Gitdocs
+
+You need to start gitdocs in order for the monitoring to work:
+
+```
+gitdocs start
+```
+
+If the start command fails, you can check the logs in `~/.gitdocs/log` or run again with the debug flag:
+
+```
+gitdocs start -D
+```
+
+Once gitdocs has been started and is monitoring the correct directories, simply start editing or adding files to your
+designated git repos and changes will be automatically pushed. Gitdocs can be easily stopped or restarted:
+
+```
+gitdocs stop
+gitdocs restart
+```
+
+For an overview of gitdocs current status, run:
+
+```
+gitdocs status
+```
+
+### Monitoring Shares
+
+You can add existing folders to watch:
+
+```
+gitdocs add my/path/to/watch
+```
+
+or instruct gitdocs to fetch a remote share and keep it synced with:
+
+```
+gitdocs create local/path/for/repo git@github.com:user/some/remote/repo.git
+```
+
+This will clone the remote repo and begin monitoring the local path. You can remove and clear monitored paths as well:
+
+```
+gitdocs rm my/path/to/watch
+gitdocs clear
+```
+
+### Web Front-end
+
+Gitdocs come with a handy web front-end that is available.
+
+<a href="http://i.imgur.com/IMwqN.png">
+  <img src="http://i.imgur.com/IMwqN.png" width="250" />
+</a>
+<a href="http://i.imgur.com/0wVyB.png">
+  <img src="http://i.imgur.com/0wVyB.png" width="250" />
+</a>
+<a href="http://i.imgur.com/Ijyo9.png">
+  <img src="http://i.imgur.com/Ijyo9.png" width="250" />
+</a>
+
+This browser front-end supports the following features:
+
+ * Explore the files within all your shares
+ * View revision history for every file in your share
+ * Revert a file to any previous state in the file's history
+ * View source files in your shares with code syntax highlighting
+ * View text files in your shares with smart formatting (markdown, textile)
+ * View any file in your shares that can be rendered inline (pdf, images, et al)
+ * Edit and update text files using a text editor
+ * Upload and create new files within your shares
+ * Manage share settings and other configuration options
+
+To check out the front-end, simply visit `http://localhost:8888` whenever gitdocs is running.
+
+### Conflict Resolution
+
+Proper conflict resolution is an important part of any good doc and file collaboration tool.
+In most cases, git does a good job of handling file merges for you. Still, what about cases where the conflict cannot be
+resolved automatically?
+
+Don't worry, gitdocs makes handling this simple. In the event of a conflict,
+**all the different versions of a document are stored** in the repo tagged with the **git sha** for each
+committed version. The members of the repo can then compare all versions and resolve the conflict.
+
+## Gitdocs in Practice
+
+At Miso, our team actually uses gitdocs in conjunction with Dropbox. We find Dropbox is ideal for galleries, videos,
+and large binary files of all sorts. We use gitdocs for storing our actual "docs":
+Task lists, wiki pages, planning docs, collaborative designs, notes, guides, code snippets, etc.
+
+You will find that the gitdocs browser front-end is well suited for this usage scenario
+since you can browse formatted wiki pages, view files with smart syntax highlighting,
+edit files with a rich text editor, search all your files, as well as view individual file revision histories.
+
+## Planned Features
+
+Gitdocs is a young project but we have many plans for it including:
+
+ - Better handling of large binary files circumventing known git limitations
+ - Click-to-share instant access granting file access to users using a local tunnel or other means.
+ - Tagging and organizing of files within the web front-end
+ - Better access to the versions for a particular file within the web front-end
+
+## Contributors
+
+Gitdocs was created at [Miso](http://engineering.gomiso.com) by [Joshua Hull](https://github.com/joshbuddy) and [Nathan Esquenazi](https://github.com/nesquena).
+We also have had several contributors:
+
+  * [Chris Kempson](https://github.com/ChrisKempson) - Encoding issues
+  * [Evan Tatarka](https://github.com/evant) - Front-end style fixes
+  * [Kale Worsley](https://github.com/kaleworsley) - Custom commit msgs, revert revisions, front-end cleanup
+
+Gitdocs is still a young project with a lot of opportunity for contributions. Patches welcome!
+
+## Prior Projects
+
+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).
+   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.
+   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
+   lacks revision history, author tracking, etc and we have features planned that are out of scope for this project
+
+If any other open-source dropbox alternatives are available, we would love to hear about them so let us know!

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
+  t.verbose = true
+end

data/bin/gitdocs

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'gitdocs'
+
+Gitdocs::Cli.start(ARGV)

data/gitdocs.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gitdocs/version"
+
+Gem::Specification.new do |s|
+  s.name        = "siuying-gitdocs"
+  s.version     = Gitdocs::VERSION
+  s.authors     = ["Josh Hull", "Nathan Esquenazi"]
+  s.email       = ["joshbuddy@gmail.com", "nesquena@gmail.com"]
+  s.homepage    = "https://github.com/siuying/gitdocs"
+  s.summary     = %q{Open-source Dropbox using Ruby and Git (my fork with github favoured markdown support)}
+  s.description = %q{Open-source Dropbox using Ruby and Git (my fork with github favoured markdown support).}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  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 'redcarpet', '~> 2.0.0'
+  s.add_dependency 'thor', '~> 0.14.6'
+  s.add_dependency 'coderay', '~> 1.0.4'
+  s.add_dependency 'dante', '~> 0.1.2'
+  s.add_dependency 'growl', '~> 1.0.3'
+  s.add_dependency 'yajl-ruby', '~> 1.1.0'
+  s.add_dependency 'haml', '~> 3.1.4'
+  s.add_dependency 'sqlite3', "~> 1.3.4"
+  s.add_dependency 'activerecord', "~> 3.1.0"
+  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 'pygments.rb'
+
+  s.add_development_dependency 'minitest', "~> 2.6.1"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'fakeweb'
+end

data/lib/gitdocs/cli.rb

@@ -0,0 +1,111 @@
+module Gitdocs
+  require 'thor'
+
+  class Cli < Thor
+    include Thor::Actions
+
+    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"
+    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
+      end
+    end
+
+    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
+      end
+    end
+
+    desc "restart", "Restarts the gitdocs process"
+    def restart
+      self.stop
+      self.start
+    end
+
+    desc "add PATH", "Adds a path to gitdocs"
+    def add(path)
+      self.config.add_path(path)
+      say "Added path #{path} to doc list"
+      self.restart if self.running?
+    end
+
+    desc "rm PATH", "Removes a path from gitdocs"
+    def rm(path)
+      self.config.remove_path(path)
+      say "Removed path #{path} from doc list"
+      self.restart if self.running?
+    end
+
+    desc "clear", "Clears all paths from gitdocs"
+    def clear
+      self.config.clear
+      say "Cleared paths from gitdocs"
+    end
+
+    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)
+      say "Created #{path} path for gitdoc"
+    end
+
+    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")
+    end
+
+    desc "config", "Configuration options for gitdocs"
+    def config
+      # TODO make this work
+    end
+
+    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)
+    end
+
+    # Helpers for thor
+    no_tasks do
+      def runner(options={})
+        Dante::Runner.new('gitdocs', options.merge(:debug => false, :daemonize => true, :pid_path => self.pid_path))
+      end
+
+      def config
+        @config ||= Configuration.new
+      end
+
+      def running?
+        self.runner.daemon_running?
+      end
+
+      def stopped?
+        self.runner.daemon_stopped?
+      end
+
+      def pid_path
+        "/tmp/gitdocs.pid"
+      end
+    end
+
+  end
+end

data/lib/gitdocs/configuration.rb

@@ -0,0 +1,79 @@
+require 'active_record'
+require 'grit'
+
+module Gitdocs
+  class Configuration
+    attr_reader :config_root
+
+    def initialize(config_root = nil)
+      @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')
+      )
+      ActiveRecord::Migrator.migrate(File.expand_path("../migration", __FILE__))
+      import_old_shares unless ENV["TEST"]
+    end
+
+    class Share < ActiveRecord::Base
+      attr_accessible :polling_interval, :path, :notification, :branch_name, :remote_name
+
+      def available_remotes
+        repo = Grit::Repo.new(path)
+        repo.remotes.map{|r| r.name}
+      rescue
+        nil
+      end
+
+      def available_branches
+        repo = Grit::Repo.new(path)
+        repo.heads.map{|r| r.name}
+      rescue
+        nil
+      end
+    end
+
+    class Config < ActiveRecord::Base
+      attr_accessible :load_browser_on_startup, :start_web_frontend, :web_frontend_port
+    end
+
+    def add_path(path, opts = nil)
+      path = self.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
+    end
+
+    def clear
+      Share.destroy_all
+    end
+
+    def shares
+      Share.all
+    end
+
+    def global
+      raise if Config.all.size > 1
+      Config.create! if Config.all.empty?
+      Config.all.first
+    end
+
+    def normalize_path(path)
+      File.expand_path(path, Dir.pwd)
+    end
+
+    private
+    def import_old_shares
+      full_path = File.expand_path('paths', config_root)
+      if File.exist?(full_path)
+        File.read(full_path).split("\n").each { |path| Share.find_or_create_by_path(path) }
+      end
+    end
+  end
+end

data/lib/gitdocs/docfile.rb

@@ -0,0 +1,23 @@
+module Gitdocs
+  class Docfile
+    attr_accessor :parent
+    attr_reader :path, :name
+
+    def initialize(path)
+      @path = path
+      @parent = File.dirname(path)
+      @name = File.basename(path)
+    end
+
+    # within?("parent", "/root/path") => "/root/path/parent"
+    def within?(dir, root)
+      expanded_root = File.expand_path(dir, root)
+      File.expand_path(@parent, root) == expanded_root ||
+        File.expand_path(@path, root).include?(expanded_root)
+    end
+
+    def dir?
+      File.directory?(@path)
+    end
+  end
+end

data/lib/gitdocs/manager.rb

@@ -0,0 +1,96 @@
+module Gitdocs
+  Restart = Class.new(RuntimeError)
+
+  class Manager
+    attr_reader :config, :debug
+
+    def initialize(config_root, debug)
+      @config = Configuration.new(config_root)
+      @logger = Logger.new(File.expand_path('log', @config.config_root))
+      @debug  = debug
+      yield @config if block_given?
+    end
+
+    RepoDescriptor = Struct.new(:name, :index)
+
+    def search(term)
+      results = {}
+      @runners.each_with_index do |runner, index|
+        descriptor = RepoDescriptor.new(runner.root, index)
+        repo_results = runner.search(term)
+        results[descriptor] = repo_results unless repo_results.empty?
+      end
+      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
+      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)
+          # 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!"
+            })
+          end
+        end
+      rescue Restart
+        retrying = 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)
+      raise
+    ensure
+      self.log("Gitdocs is terminating...goodbye\n\n")
+    end
+
+    def restart
+      Thread.new do
+        Thread.main.raise Restart, "restarting ... "
+        sleep 0.1 while EM.reactor_running?
+        start
+      end
+    end
+
+    def stop
+      EM.stop
+    end
+
+    protected
+
+    # Logs and outputs to file or stdout based on debugging state
+    # log("message")
+    def log(msg, level=:info)
+      @debug ? puts(msg) : @logger.send(level, msg)
+    end
+  end
+end