gitdocs 0.4.0 → 0.4.1

data/CHANGELOG

@@ -0,0 +1,6 @@
+0.4.1 (12/13/2012)
+
+  * Adds a basic search to web front-end
+  * Beginning of the work towards cross-platform notifications
+
+0.4.2 (Not yet released)

data/README.md

@@ -59,27 +59,6 @@ to enable Growl support (other platforms coming soon).
 
 ## Usage
 
-### 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
-```
-
 ### Starting Gitdocs
 
 You need to start gitdocs in order for the monitoring to work:
@@ -107,19 +86,43 @@ For an overview of gitdocs current status, run:
 ```
 gitdocs status
 ```
-### 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?
+### Monitoring Shares
 
-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 the commit for each variation. The members
-of the repo can then compare all versions and resolve the conflict.
+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. This browser front-end supports the following features:
+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 source files in your shares with code syntax highlighting
@@ -131,6 +134,16 @@ Gitdocs come with a handy web front-end that is available. This browser front-en
 
 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.
+
 ## Planned Features
 
 Gitdocs is a young project but we have big plans for it including:
@@ -145,8 +158,8 @@ Gitdocs is a young project but we have big plans for it including:
 Gitdocs is a fresh project that we 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. Nice project and a great alternative but has a lot of dependencies,
-   and lacks some of the features we have planned for gitdocs in the near future. More mature project, so be sure to take a look.
+ * [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.

data/lib/gitdocs.rb

@@ -1,5 +1,4 @@
 require 'thread'
-require 'growl'
 require 'yajl'
 require 'dante'
 require 'socket'

data/lib/gitdocs/manager.rb

@@ -10,6 +10,17 @@ module Gitdocs
       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)
+        results[descriptor] = runner.search(term)
+      end
+      results
+    end
+
     def run
       run = true
       trap('USR1') { run = true; EM.stop }
@@ -21,11 +32,11 @@ module Gitdocs
         # Start the repo watchers
         runners = nil
         EM.run do
-          runners = config.shares.map { |share| Runner.new(share) }
-          runners.each(&:run)
+          @runners = config.shares.map { |share| Runner.new(share) }
+          @runners.each(&:run)
           # Start the web front-end
           if self.config.global.start_web_frontend
-            Server.new(self, *runners).start
+            Server.new(self, *@runners).start
             i = 0
             web_started = false
             begin
@@ -39,7 +50,7 @@ module Gitdocs
             system("open http://localhost:8888/") if self.config.global.load_browser_on_startup && web_started
           end
         end
-        sleep(10) if runners && runners.empty?
+        sleep(10) if @runners && @runners.empty?
       end
     end
 

data/lib/gitdocs/public/js/search.js

@@ -0,0 +1,13 @@
+GitDocs.search = {
+  highlight : function(query) {
+    $('.results dl dd').each(function(idx, el) {
+      var result = $(el).text().replace(query, "<strong>" + query + "</strong>");
+      $(el).html(result);
+    });
+  }
+};
+
+$(document).ready(function() {
+  var query = $('.results').data("query");
+  GitDocs.search.highlight(query);
+});

data/lib/gitdocs/runner.rb

@@ -11,13 +11,23 @@ module Gitdocs
       @icon = File.expand_path("../../img/icon.png", __FILE__)
     end
 
+    SearchResult = Struct.new(:file, :context)
+    def search(term)
+      results = []
+      sh_string("git grep #{ShellTools.escape(term)}").scan(/(.*?):([^\n]*)/) do |(file, context)|
+        results << SearchResult.new(file, context)
+      end
+      results
+    end
+
     def run
       return false unless self.valid?
-      out, status = sh_with_code "which growlnotify"
-      @use_growl = @share.notification && status.success?
-      @current_remote   = @share.remote_name
-      @current_branch   = @share.branch_name
-      @current_revision = sh_string("git rev-parse HEAD")
+      @show_notifications = @share.notification
+      @current_remote     = @share.remote_name
+      @current_branch     = @share.branch_name
+      @current_revision   = sh_string("git rev-parse HEAD")
+      Guard::Notifier.turn_on if @show_notifications
+
       mutex = Mutex.new
 
       info("Running gitdocs!", "Running gitdocs in `#{@root}'")
@@ -156,24 +166,24 @@ module Gitdocs
     end
 
     def warn(title, msg)
-      if @use_growl
-        Growl.notify_warning(msg, :title => title)
+      if @show_notifications
+        Guard::Notifier.notify(msg, :title => title)
       else
         Kernel.warn("#{title}: #{msg}")
       end
     end
 
     def info(title, msg)
-      if @use_growl
-        Growl.notify_ok(msg, :title => title, :icon => @icon)
+      if @show_notifications
+        Guard::Notifier.notify(msg, :title => title, :image => @icon)
       else
         puts("#{title}: #{msg}")
       end
     end
 
     def error(title, msg)
-      if @use_growl
-        Growl.notify_error(msg, :title => title)
+      if @show_notifications
+        Guard::Notifier.notify(msg, :title => title, :image => :failure)
       else
         Kernel.warn("#{title}: #{msg}")
       end

data/lib/gitdocs/server.rb

@@ -36,6 +36,10 @@ module Gitdocs
               end
             end
 
+            path('search').get do
+              render! "search", :layout => 'app', :locals => {:conf => manager.config, :results => manager.search(request.GET['q']), :nav_state => nil}
+            end
+
             var :int do |idx|
               gd = gds[idx]
               halt 404 if gd.nil?

data/lib/gitdocs/version.rb

@@ -1,3 +1,3 @@
 module Gitdocs
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/gitdocs/views/app.haml

@@ -19,6 +19,8 @@
               %a(href = "/") Home
             %li{ :class => ("active" if nav_state == "settings") }
               %a(href = "/settings") Settings
+          %form{:class => "pull-left", :action => "/search", :method => 'GET'}
+            %input{:type => "text", :placeholder => "Search", :name => 'q'}
 
     #main.container
       .content

data/lib/gitdocs/views/search.haml

@@ -0,0 +1,14 @@
+- @title = "Matches for #{request.params['q'].inspect}"
+
+.results{ "data-query" => request.params['q'] }
+  - results.each do |repo, search_results|
+    %h2= repo.name
+    %dl
+      - search_results.each do |res|
+        %dt
+          %a{:href => "/#{repo.index}/#{res.file}"}
+            = "/#{res.file}"
+        %dd
+          = res.context
+
+%script{ :src => "/js/search.js", :type => "text/javascript", :charset => "utf-8" }

metadata

@@ -2,7 +2,7 @@
 name: gitdocs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Josh Hull
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-11 00:00:00 Z
+date: 2011-12-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: joshbuddy-guard
@@ -223,6 +223,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
@@ -243,7 +244,11 @@ files:
 - lib/gitdocs/public/css/bootstrap.css
 - lib/gitdocs/public/css/coderay.css
 - lib/gitdocs/public/css/tilt.css
+- lib/gitdocs/public/img/error.png
 - lib/gitdocs/public/img/git_logo.png
+- lib/gitdocs/public/img/info.png
+- lib/gitdocs/public/img/ok.png
+- lib/gitdocs/public/img/warning.png
 - lib/gitdocs/public/js/ace/ace-compat.js
 - lib/gitdocs/public/js/ace/ace-uncompressed.js
 - lib/gitdocs/public/js/ace/ace.js
@@ -276,6 +281,7 @@ files:
 - lib/gitdocs/public/js/app.js
 - lib/gitdocs/public/js/edit.js
 - lib/gitdocs/public/js/jquery.js
+- lib/gitdocs/public/js/search.js
 - lib/gitdocs/public/js/util.js
 - lib/gitdocs/runner.rb
 - lib/gitdocs/server.rb
@@ -287,6 +293,7 @@ files:
 - lib/gitdocs/views/edit.haml
 - lib/gitdocs/views/file.haml
 - lib/gitdocs/views/home.haml
+- lib/gitdocs/views/search.haml
 - lib/gitdocs/views/settings.haml
 - lib/img/icon.png
 - test/configuration_test.rb
@@ -315,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gitdocs
-rubygems_version: 1.8.10
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Open-source Dropbox using Ruby and Git