gitdocs 0.5.0.pre6 → 0.5.0.pre7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGUwYWI0Y2RjMTNjZGU4YzMzMzkxMTcxOTQ3OGQ2YWY0ZGNmZjg3MA==
+    ZTBiOGM2MTgxYWMwYTBlZTkzMTRhNTAxYTMyMTgyYTM1NjdmNjgyMQ==
   data.tar.gz: !binary |-
-    MjZhNjUxNGM4Yjc2Nzk1NWRkYjJiNjNlNzYyNTA3NGEzNjFkMTcyNw==
+    ZTc1ZTFiNWVjZjVlYjk0MDgyYmE4NGNiNzJjZTQzNzdjY2Q2YTgwMg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NWY0NTMyOTQ1NGJhMTg5OTY3OWNhMGE4MzFhYjJjNzA1N2Y4YTgzMWIwMTE4
-    NDZkMWIzMzFlYzNhYzc5MjAyMmQ3NGJiMzY3ZDliMzhkMTE5ZWQxNjE3MTk3
-    Y2E4YTIzZTU2ODg3N2Y5YjRmNDFiNzM1MzZhMzczN2E4Yzk0ODI=
+    Yzk2NDFmMmJkYmM4MDllOTVmOWZhYjM0NDM3MzFjNzY1NzUyNGE3Mzk5ZGE5
+    MWNhODBjN2U5YTA5YjkzZjIwZDI5YzAyNzIyM2RiZTYwYTMzYjIwYjhkYTY0
+    MmExYjFlNzFlN2VkOWUyNGYwNTg1MjUyYjU2ZmM5YTk1MTU0MzE=
   data.tar.gz: !binary |-
-    ODFiYjQ4ZmI3NWVlNzU5ZWY5NDQ3Mzk4OGRhMGNmMWQ5ZDBjNGNmYjcyYzM2
-    N2RhMzZlZDExYzYyOTMyZWE4OWVkYTA1N2Y1NDRiMmFjYTM4YmM3N2QzZWUw
-    OTRlZWZkOGJlMDg1MGQ4NGY4OThjOGRhN2Q1MjI5NzAyODcyZjA=
+    OWZiZjNkOGZiYjc4NzcwNjAxYmRmNmExOTQwMTAzODYzYjBhNzRlYzI5ZjMy
+    MjczNTJlMDcwYjQwZGM0Y2NlMTg4N2MyYzlhMGIyOWY0N2M3MTQ2NDJhODJi
+    MDNhMzEyZDcxYjlhNTRhZDU2NGQxOTQwNDA2NGZiNDYwNjdjYWM=

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 .DS_Store
 tmp
+coverage

data/.haml-lint.yml

@@ -0,0 +1,3 @@
+linters:
+  LineLength:
+    enabled: false

data/.jslint.yml

@@ -0,0 +1,84 @@
+# ------------ rake task options ------------
+
+# JS files to check by default, if no parameters are passed to rake jslint
+# (you may want to limit this only to your own scripts and exclude any external scripts and frameworks)
+
+# this can be overridden by adding 'paths' and 'exclude_paths' parameter to rake command:
+#   rake jslint paths=path1,path2,... exclude_paths=library1,library2,...
+
+paths:
+  - lib/gitdocs/public/js/**/*.js
+
+exclude_paths:
+  - lib/gitdocs/public/js/ace/**/*.js
+  - lib/gitdocs/public/js/jquery.tablesorter.js
+  - lib/gitdocs/public/js/jquery.js
+  - lib/gitdocs/public/js/bootstrap-alerts.js
+
+
+# ------------ jslint options ------------
+# see http://www.jslint.com/lint.html#options for more detailed explanations
+
+# "enforce" type options (true means potentially more warnings)
+
+adsafe:   false     # true if ADsafe rules should be enforced. See http://www.ADsafe.org/
+bitwise:  true      # true if bitwise operators should not be allowed
+newcap:   true      # true if Initial Caps must be used with constructor functions
+eqeqeq:   false     # true if === should be required (for ALL equality comparisons)
+immed:    false     # true if immediate function invocations must be wrapped in parens
+nomen:    false     # true if initial or trailing underscore in identifiers should be forbidden
+onevar:   false     # true if only one var statement per function should be allowed
+plusplus: false     # true if ++ and -- should not be allowed
+regexp:   false     # true if . and [^...] should not be allowed in RegExp literals
+safe:     false     # true if the safe subset rules are enforced (used by ADsafe)
+strict:   false     # true if the ES5 "use strict"; pragma is required
+undef:    false     # true if variables must be declared before used
+white:    false     # true if strict whitespace rules apply (see also 'indent' option)
+
+# "allow" type options (false means potentially more warnings)
+
+cap:      false     # true if upper case HTML should be allowed
+css:      true      # true if CSS workarounds should be tolerated
+debug:    false     # true if debugger statements should be allowed (set to false before going into production)
+es5:      false     # true if ECMAScript 5 syntax should be allowed
+evil:     false     # true if eval should be allowed
+forin:    true      # true if unfiltered 'for in' statements should be allowed
+fragment: true      # true if HTML fragments should be allowed
+laxbreak: false     # true if statement breaks should not be checked
+on:       false     # true if HTML event handlers (e.g. onclick="...") should be allowed
+sub:      false     # true if subscript notation may be used for expressions better expressed in dot notation
+
+# other options
+
+maxlen:   120       # Maximum line length
+indent:   2         # Number of spaces that should be used for indentation - used only if 'white' option is set
+maxerr:   50        # The maximum number of warnings reported (per file)
+passfail: false     # true if the scan should stop on first error (per file)
+# following are relevant only if undef = true
+predef:   ''        # Names of predefined global variables - comma-separated string or a YAML array
+browser:  true      # true if the standard browser globals should be predefined
+rhino:    false     # true if the Rhino environment globals should be predefined
+windows:  false     # true if Windows-specific globals should be predefined
+widget:   false     # true if the Yahoo Widgets globals should be predefined
+devel:    true      # true if functions like alert, confirm, console, prompt etc. are predefined
+
+
+# ------------ jslint_on_rails custom lint options (switch to true to disable some annoying warnings) ------------
+
+# ignores "missing semicolon" warning at the end of a function; this lets you write one-liners
+# like: x.map(function(i) { return i + 1 }); without having to put a second semicolon inside the function
+lastsemic: false
+
+# allows you to use the 'new' expression as a statement (without assignment)
+# so you can call e.g. new Ajax.Request(...), new Effect.Highlight(...) without assigning to a dummy variable
+newstat: false
+
+# ignores the "Expected an assignment or function call and instead saw an expression" warning,
+# if the expression contains a proper statement and makes sense; this lets you write things like:
+#    element && element.show();
+#    valid || other || lastChance || alert('OMG!');
+#    selected ? show() : hide();
+# although these will still cause a warning:
+#    element && link;
+#    selected ? 5 : 10;
+statinexp: false

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Documentation:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+# Splitting method arguments across multiple lines can result in the containing
+# method looking long, but not actually increasing the complexity at all.
+MethodLength:
+  Enabled: false
+
+EachWithObject:
+  Enabled: false

data/CHANGELOG

@@ -1,3 +1,14 @@
+0.5.0.pre7 (August 3rd 2014)
+
+ * UI improvements to repo browser (@acant)
+ * upgrade dependencies (@acant)
+ * add integration testing for repo browser (@acant)
+ * include hidden files in directory listing (@acant)
+ * refactor the server, cleanup file manipulation (@acant)
+ * add fetch only syncing for repositories (@acant)
+ * add sync status for reach repository in the CLI status (@acant)
+ * fix display of hidden files in the web UI (@acant)
+
 0.5.0.pre6 (May 24th 2014)
 
  * Remove the load_browser_on_startup config option (@acant)

data/README.md

@@ -3,6 +3,9 @@
 [![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)
 [![Build Status](https://travis-ci.org/nesquena/gitdocs.svg?branch=master)](https://travis-ci.org/nesquena/gitdocs)
+[![Inline docs](http://inch-ci.org/github/nesquena/gitdocs.png?branch=master)](http://inch-ci.org/github/nesquena/gitdocs)
+[![Dependency Status](https://gemnasium.com/nesquena/gitdocs.svg)](https://gemnasium.com/nesquena/gitdocs)
+[![Coverage Status](https://coveralls.io/repos/nesquena/gitdocs/badge.png?branch=master)](https://coveralls.io/r/nesquena/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.
@@ -10,7 +13,7 @@ This allows any git repo to be used as a collaborative task list, file share, or
 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)
+Windows support is [half-baked](https://github.com/nesquena/gitdocs/issues/7)
 but we plan to tackle that shortly in an upcoming release.
 
 ## Why?
@@ -171,7 +174,8 @@ Gitdocs is a young project but we have many plans for it including:
 
 ## Contributors
 
-Gitdocs was created at [Miso](http://engineering.gomiso.com) by [Joshua Hull](https://github.com/joshbuddy) and [Nathan Esquenazi](https://github.com/nesquena).
+Gitdocs is now primarily being developed by [Andrew Sullivan Cant](https://github.com/acant). 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

data/Rakefile

@@ -1,10 +1,29 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'jslint/tasks'
 
+JSLint.config_path = '.jslint.yml'
+
+namespace :test do
+  # Separate the unit and integration tests when running the entire suite.
+  Rake::TestTask.new(:unit) do |t|
+    t.libs.push('lib')
+    t.test_files = FileList[File.expand_path('../test/unit/**/*_test.rb', __FILE__)]
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(integration: :unit) do |t|
+    t.libs.push('lib')
+    t.test_files = FileList[File.expand_path('../test/integration/**/*_test.rb', __FILE__)]
+    t.verbose = true
+  end
+end
+
+# Keep a default test task for manually running any test
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
+  t.libs.push('lib')
   t.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
   t.verbose = true
 end
 
-task :default => [:test]
+task default: 'test:integration'

data/gitdocs.gemspec

@@ -1,48 +1,55 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "gitdocs/version"
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'gitdocs/version'
 
 Gem::Specification.new do |s|
-  s.name        = "gitdocs"
+  s.name        = 'gitdocs'
   s.version     = Gitdocs::VERSION
-  s.authors     = ["Josh Hull", "Nathan Esquenazi"]
-  s.email       = ["joshbuddy@gmail.com", "nesquena@gmail.com"]
-  s.homepage    = "http://engineering.gomiso.com/2011/11/30/collaborate-and-track-tasks-with-ease-using-gitdocs/"
-  s.summary     = %q{Open-source Dropbox using Ruby and Git}
-  s.description = %q{Open-source Dropbox using Ruby and Git.}
+  s.authors     = ['Josh Hull', 'Nathan Esquenazi']
+  s.email       = ['joshbuddy@gmail.com', 'nesquena@gmail.com']
+  s.homepage    = 'http://engineering.gomiso.com/2011/11/30/collaborate-and-track-tasks-with-ease-using-gitdocs/'
+  s.summary     = 'Open-source Dropbox using Ruby and Git.'
+  s.description = 'Open-source Dropbox using Ruby and Git.'
+  s.license     = 'MIT'
 
-  s.rubyforge_project = "gitdocs"
+  s.rubyforge_project = 'gitdocs'
 
   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.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.5.1'
-  s.add_dependency 'renee', '~> 0.3.11'
-  s.add_dependency 'redcarpet', '~> 3.1.1'
-  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.3'
-  s.add_dependency 'launchy', '~> 2.4.2'
-  s.add_dependency 'rugged', '~> 0.19.0'
+  s.add_dependency 'thin',            '~> 1.6.2'
+  s.add_dependency 'renee',           '~> 0.3.11'
+  s.add_dependency 'redcarpet',       '~> 3.1.1'
+  s.add_dependency 'thor',            '~> 0.14.6'
+  s.add_dependency 'coderay',         '~> 1.1.0'
+  s.add_dependency 'dante',           '~> 0.1.2'
+  s.add_dependency 'growl',           '~> 1.0.3'
+  s.add_dependency 'haml',            '~> 4.0.5'
+  s.add_dependency 'sqlite3',         '~> 1.3.4'
+  s.add_dependency 'activerecord',    '~> 4.1.4'
+  s.add_dependency 'grit',            '~> 2.5.0'
+  s.add_dependency 'shell_tools',     '~> 0.1.0'
+  s.add_dependency 'mimetype-fu',     '~> 0.1.2'
+  s.add_dependency 'eventmachine',    '>= 1.0.3'
+  s.add_dependency 'launchy',         '~> 2.4.2'
+  s.add_dependency 'rugged',          '~> 0.19.0'
+  s.add_dependency 'table_print',     '~> 1.5.1'
 
-  s.add_development_dependency 'minitest', "~> 5.0.8"
+  s.add_development_dependency 'minitest',               '~> 5.4.0'
+  s.add_development_dependency 'capybara_minitest_spec', '~> 1.0.2'
+  s.add_development_dependency 'poltergeist',            '~> 1.5.1'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'fakeweb'
   s.add_development_dependency 'metric_fu'
   s.add_development_dependency 'aruba'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'haml-lint',              '~> 0.6.0'
+  s.add_development_dependency 'jslint_on_rails',        '~> 1.1.1'
+  s.add_development_dependency 'coveralls',              '~> 0.7.0'
 end

data/lib/gitdocs.rb

@@ -1,11 +1,13 @@
+# -*- encoding : utf-8 -*-
+
 require 'thread'
-require 'yajl'
 require 'dante'
 require 'socket'
 require 'shell_tools'
 require 'guard'
 require 'grit'
 require 'rugged'
+require 'table_print'
 
 require 'gitdocs/version'
 require 'gitdocs/configuration'
@@ -13,10 +15,11 @@ require 'gitdocs/runner'
 require 'gitdocs/server'
 require 'gitdocs/cli'
 require 'gitdocs/manager'
-require 'gitdocs/docfile'
 require 'gitdocs/rendering'
 require 'gitdocs/notifier'
 require 'gitdocs/repository'
+require 'gitdocs/repository/path'
+require 'gitdocs/search'
 
 module Gitdocs
   DEBUG = ENV['DEBUG']

data/lib/gitdocs/cli.rb

@@ -1,10 +1,16 @@
+# -*- encoding : utf-8 -*-
+
+# rubocop:disable LineLength, ClassLength
+
 module Gitdocs
   require 'thor'
 
   class Cli < Thor
     include Thor::Actions
 
-    def self.source_root; File.expand_path('../../', __FILE__); end
+    def self.source_root
+      File.expand_path('../../', __FILE__)
+    end
 
     desc 'start', 'Starts a daemonized gitdocs process'
     method_option :debug, type: :boolean, aliases: '-D'
@@ -84,8 +90,25 @@ module Gitdocs
       say "GitDoc v#{VERSION}"
       say "Running: #{running?}"
       say "File System Watch Method: #{file_system_watch_method}"
-      say 'Watching paths:'
-      say config.shares.map { |s| "  - #{s.path}" }.join("\n")
+      say 'Watched repositories:'
+      tp.set(:max_width, 100)
+      status_display = lambda do |share|
+        repository = Gitdocs::Repository.new(share)
+
+        status = ''
+        status += '*' if repository.dirty?
+        status += '!' if repository.need_sync?
+
+        status = 'ok' if status.empty?
+        status
+      end
+      tp(
+        config.shares,
+        { sync: { display_method: :sync_type } },
+        { s: status_display },
+        :path
+      )
+      say "\n(Legend: ok everything synced, * change to commit, ! needs sync)"
     end
 
     desc 'open', 'Open the Web UI'
@@ -97,14 +120,14 @@ module Gitdocs
       end
 
       web_port = options[:port]
-      web_port ||= config.global.web_frontend_port
+      web_port ||= config.web_frontend_port
       Launchy.open("http://localhost:#{web_port}/")
     end
 
     # TODO: make this work
-    #desc 'config', 'Configuration options for gitdocs'
-    #def config
-    #end
+    # desc 'config', 'Configuration options for gitdocs'
+    # def config
+    # end
 
     desc 'help', 'Prints out the help'
     def help(task = nil, subcommand = false)
@@ -140,7 +163,7 @@ module Gitdocs
       end
 
       # @return [Symbol] to indicate how the file system is being watched
-      def file_system_watch_method
+      def file_system_watch_method # rubocop:disable CyclomaticComplexity
         if Guard::Listener.mac? && Guard::Darwin.usable?
           :notification
         elsif Guard::Listener.linux? && Guard::Linux.usable?

data/lib/gitdocs/configuration.rb

@@ -1,66 +1,112 @@
+# -*- encoding : utf-8 -*-
+
 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 Gitdocs::Configuration
+  attr_reader :config_root
 
-    class Share < ActiveRecord::Base
-      attr_accessible :polling_interval, :path, :notification, :branch_name, :remote_name
-    end
+  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 Config < ActiveRecord::Base
-      attr_accessible :start_web_frontend, :web_frontend_port
-    end
+  class Share < ActiveRecord::Base
+    #attr_accessible :polling_interval, :path, :notification, :branch_name, :remote_name, :sync_type
+  end
 
-    def add_path(path, opts = nil)
-      path = normalize_path(path)
-      path_opts = { path: path }
-      path_opts.merge!(opts) if opts
-      Share.new(path_opts).save!
-    end
+  class Config < ActiveRecord::Base
+    #attr_accessible :start_web_frontend, :web_frontend_port
+  end
 
-    def remove_path(path)
-      path = normalize_path(path)
-      Share.where(path: path).destroy_all
-    end
+  # return [Boolean]
+  def start_web_frontend
+    global.start_web_frontend
+  end
 
-    def clear
-      Share.destroy_all
-    end
+  # @return [Integer]
+  def web_frontend_port
+    global.web_frontend_port
+  end
 
-    def shares
-      Share.all
-    end
+  # @param [String] path
+  # @param [Hash] opts
+  def add_path(path, opts = nil)
+    path = normalize_path(path)
+    path_opts = { path: path }
+    path_opts.merge!(opts) if opts
+    Share.new(path_opts).save!
+  end
 
-    def global
-      fail if Config.all.size > 1
-      Config.create! if Config.all.empty?
-      Config.all.first
-    end
+  # @param [Hash] new_config
+  # @option new_config [Hash] 'config'
+  # @option new_config [Array<Hash>] 'share'
+  def update_all(new_config)
+    global.update_attributes(new_config['config'])
+    new_config['share'].each do |index, share_config|
+      # Skip the share update if there is no path specified.
+      next unless share_config['path'] && !share_config['path'].empty?
 
-    def normalize_path(path)
-      File.expand_path(path, Dir.pwd)
+      # Split the remote_branch into remote and branch
+      remote_branch = share_config.delete('remote_branch')
+      if remote_branch
+        share_config['remote_name'], share_config['branch_name'] = remote_branch.split('/', 2)
+      end
+      shares[index.to_i].update_attributes(share_config)
     end
+  end
 
-    private
+  # @param [String] path of the share to remove
+  def remove_path(path)
+    path = normalize_path(path)
+    Share.where(path: path).destroy_all
+  end
 
-    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
+  # @param [Integer] id of the share to remove
+  #
+  # @return [true] share was deleted
+  # @return [false] share does not exist
+  def remove_by_id(id)
+    Share.find(id).destroy
+    true
+  rescue ActiveRecord::RecordNotFound
+    false
+  end
+
+  def clear
+    Share.destroy_all
+  end
+
+  def shares
+    Share.all
+  end
+
+  ##############################################################################
+
+  private
+
+  def global
+    fail 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
+
+  def import_old_shares
+    full_path = File.expand_path('paths', config_root)
+    return unless File.exist?(full_path)
+
+    File.read(full_path).split("\n").each do |path|
+      Share.find_or_create_by_path(path)
     end
   end
 end