redsync 0.1.1 → 0.1.2

data/README.textile

@@ -4,54 +4,57 @@ h2. What's this?
 
 Sync your Redmine's wiki contents to your local filesystem.
 Edit them while offline, then upsync them to Redmine.
+(Requires Ruby 1.9)
 
-h2. Usage
-
-Copy and edit config.yml.dist -> config.yml
+h2. Install
 
 <pre>
---- 
-:url: "http://your.redmine.url/"
-:project_slug: "project_identifier"
-:username: "username"
-:password: "password"
-:data_dir: "~/redsync"
+gem install redsync
 </pre>
 
-Run @bin/redsync@
+
+h2. Usage
 
 <pre>
+$ redsync --help
 Usage: redsync [options]
     -v, --[no-]verbose               Output verbose logs
-    -c, --config FILE                Use specified config file instead of config.yml
+    -c, --config FILE                Use specified config file instead of ~/redsync.yml
     -u, --upsync-only                Upsync only, don't downsync
     -d, --downsync-only              Downsync only, don't upsync
 </pre>
 
-h2. Dependencies
-
-* Ruby 1.9
-* Mechanize (@gem install mechanize@)
-* ActiveSupport (@gem install activesupport@)
 
 h2. How it works
 
 Just some scraping...
 
+
 h2. Warnings
 
 This software has NOT BEEN TESTED :(
 Use it at your own risk.
 Please beware that it may not work on all versions of Redmine (it's working fine with my installation of 1.2-stable)
 
+h3. Time zones
+
 Redsync assumes that your local timezone is the same as your Redmine timezone.
 Sign in and go to "My Account" to change it.
 
-Redsync does not deal with edit conflicts well.
+h3. Conflicts
+
+Redsync does not deal with conflicts well.
 In fact, it does not deal with conflics AT ALL.
 A default run of redsync will downsync first, overwriting any local changes if pages are updated on Redmine.
 Then it will upsync any remaining changes.
 
+h3. Deletions
+
+Redsy does not delete anything.
+It doesn't delete local files when remote wiki pages are gone.
+It doesn't delete remote wiki pages when local files are gone either.
+
+
 h2. License
 
 The MIT License

data/lib/redsync.rb

@@ -10,35 +10,38 @@ require 'mechanize'
 require 'active_support/all'
 
 require 'redsync/cli'
+require 'redsync/sync_stat'
 
 
 class Redsync
 
-  class Status
+  class Result
     DOWNLOADED = 1
     SKIPPED_UNKNOWN = 2
     SKIPPED_OLD = 4
     UPLOADED = 8
     CREATED = 16
-    ERROR_ON_CREATE = 32
-    ERROR_ON_EDIT = 64
+    ERROR_ON_UPLOAD = 32
+    ERROR_ON_CREATE = 64
   end
 
+
   def initialize(options)
     @config = {}
     @config.merge! options
     @config[:data_dir] = File.expand_path(@config[:data_dir])
     @config[:conflicts_dir] = File.join(@config[:data_dir], "__redsync_conflicts__")
-    @config[:pages_list_file] = File.join(@config[:data_dir], "__redsync_pages_list__.yml")
     puts "Using data dir: #{@config[:data_dir]}"
 
-    @login_url = @config[:url] + "/login"
-    @wiki_base_url = @config[:url] + "/projects/" + @config[:project_slug] + "/wiki"
+    @config[:url] = @config[:url].match(/(.*?)\/?$/)[1]
+    @config[:login_url] = @config[:url] + "/login"
+    @config[:wiki_base_url] = @config[:url] + "/projects/" + @config[:project_slug] + "/wiki"
 
     initialize_system_files
-    recover_pages_list
 
     @agent = Mechanize.new
+    @syncstat = SyncStat.new(@config, @agent)
+
     @logged_in = false
   end
 
@@ -48,19 +51,17 @@ class Redsync
       puts "Creating data dir"
       FileUtils.mkdir(@config[:data_dir]) 
     end
-    FileUtils.mkdir(@config[:conflicts_dir]) unless File.exist? @config[:conflicts_dir]
-    FileUtils.touch(@config[:pages_list_file]) unless File.exist? @config[:pages_list_file]
   end
 
 
   def login
-    puts "Logging in as #{@config[:username]} to #{@login_url}..."
-    page = @agent.get(@login_url)
+    puts "Logging in as #{@config[:username]} to #{@config[:login_url]}..."
+    page = @agent.get(@config[:login_url])
     login_form = page.form_with(:action => "/login")
     login_form.field_with(:name => "username").value = @config[:username]
     login_form.field_with(:name => "password").value = @config[:password]
     result_page = login_form.submit
-    if result_page.link_with(:text => "Sign out")
+    if result_page.search("a.logout").any?
       puts "Logged in successfully."
       return true
     else
@@ -70,166 +71,76 @@ class Redsync
   end
 
 
-  def pages
-    refresh_pages_list if (!@pages || @pages.empty?)
-    @pages
-  end
-
-
   def downsync
+    @syncstat.refresh
     puts "\nDownsync:"
     statuses = {
-      Status::DOWNLOADED => 0,
-      Status::SKIPPED_OLD => 0,
-      Status::SKIPPED_UNKNOWN => 0,
+      Result::DOWNLOADED => 0,
     }
-    pages.each do |pagename, info|
-      statuses[downsync_page(pagename)] += 1
+    @syncstat.remote_updated_page_names.each do |pagename|
+      statuses[download(pagename)] += 1
     end
-    puts "Downloaded #{statuses[Status::DOWNLOADED]} pages."
-    puts "Skipped #{statuses[Status::SKIPPED_OLD] + statuses[Status::SKIPPED_UNKNOWN]} pages."
+    puts "Downloaded #{statuses[Result::DOWNLOADED]} pages."
   end
 
 
-  def downsync_page(pagename)
-    now = DateTime.now
-
-    page_info = pages[pagename]
-    if !page_info
-      puts "--Skipping #{pagename}: unknown page"
-      return Status::SKIPPED_UNKNOWN
-    end
-
-    filename = File.join(@config[:data_dir], "#{pagename}.txt")
-
-    if File.exist? filename
-      local_updated_at = File.stat(filename).mtime.to_datetime
-      remote_updated_at = DateTime.parse(page_info[:updated_at_str] + "T00:00:00" + now.zone)
-      if remote_updated_at.year == now.year && remote_updated_at.month == now.month && remote_updated_at.day == now.day
-        remote_updated_at = page_history(pagename)[0][:timestamp]
-      end
-      if local_updated_at >= remote_updated_at
-        puts "--Skip #{pagename}: local (#{local_updated_at}) is newer than remote (#{remote_updated_at})" if @config[:verbose]
-        return Status::SKIPPED_OLD
-      end
-    end
+  def download(pagename)
+    stat = @syncstat.for(pagename)
 
     puts "--Download #{pagename}"
-    page = @agent.get(page_info[:url] + "/edit")
-    File.open(filename, "w+:UTF-8") { |f| f.write(page.search("textarea")[0].text) }
-    @pages[pagename][:downloaded_at] = File.stat(filename).mtime.to_datetime
-    write_pages_list
+    page = @agent.get(stat[:url] + "/edit")
+    File.open(stat[:local_file], "w+:UTF-8") { |f| f.write(page.search("textarea")[0].text) }
+    @syncstat.update(pagename, :downloaded_at => File.stat(stat[:local_file]).mtime.to_datetime)
 
-    return Status::DOWNLOADED
+    return Result::DOWNLOADED
   end
 
 
   def upsync
     puts "\nUpsync:"
-    statuses = {
-      Status::UPLOADED => 0,
-      Status::SKIPPED_OLD => 0,
-      Status::CREATED => 0,
-      Status::ERROR_ON_CREATE => 0,
-      Status::ERROR_ON_EDIT => 0
+    results = {
+      Result::UPLOADED => 0,
+      Result::CREATED => 0,
+      Result::ERROR_ON_UPLOAD => 0,
+      Result::ERROR_ON_CREATE => 0,
     }
-    Dir.entries(@config[:data_dir]).each do |file|
-      fullpath = File.join(@config[:data_dir], file)
-      next if File.directory?(fullpath)
-      next if file =~ /^__redsync_/
-      file = Iconv.iconv("UTF-8", "UTF-8-MAC", file).first
-      statuses[upsync_page(File.basename(file, ".txt"))] += 1
+    @syncstat.new_page_names.each do |pagename|
+      results[upload(pagename, true)] += 1
+    end
+    @syncstat.local_updated_page_names.each do |pagename|
+      results[upload(pagename)] += 1
     end
-    print "Created #{statuses[Status::CREATED]} pages."
-    print " (#{statuses[Status::ERROR_ON_CREATE]} errors)" if statuses[Status::ERROR_ON_CREATE] > 0
+    print "Created #{results[Result::CREATED]} pages."
+    print " (#{results[Result::ERROR_ON_CREATE]} errors)" if results[Result::ERROR_ON_CREATE] > 0
     print "\n"
-    print "Uploaded #{statuses[Status::UPLOADED]} pages."
-    print " (#{statuses[Status::ERROR_ON_EDIT]} errors)" if statuses[Status::ERROR_ON_EDIT] > 0
+    print "Uploaded #{results[Result::UPLOADED]} pages."
+    print " (#{results[Result::ERROR_ON_UPLOAD]} errors)" if results[Result::ERROR_ON_UPLOAD] > 0
     print "\n"
-    puts "Skipped #{statuses[Status::SKIPPED_OLD]} pages."
   end
 
 
-  def upsync_page(pagename)
+  def upload(pagename, create = false)
     now = DateTime.now
-    page_info = pages[pagename]
-    filename = File.join(@config[:data_dir], "#{pagename}.txt")
-    local_updated_at = File.stat(filename).mtime.to_datetime
+    stat = @syncstat.for(pagename)
+    puts (create ? "--Create #{pagename}" : "--Upload #{pagename}")
 
-    if page_info.try(:[], :downloaded_at) && local_updated_at <= page_info[:downloaded_at].to_datetime
-      puts "--Skip #{pagename}" if @config[:verbose]
-      return Status::SKIPPED_OLD
-    end
-
-    puts (page_info ? "--Upload #{pagename}" : "--Create #{pagename}")
-    page = @agent.get(@wiki_base_url + "/" + pagename + "/edit")
+    page = @agent.get(@config[:wiki_base_url] + "/" + pagename + "/edit")
     form = page.form_with(:id=>"wiki_form")
-    form.field_with(:name=>"content[text]").value = File.open(filename, "r:UTF-8").read
+    form.field_with(:name=>"content[text]").value = File.open(stat[:local_file], "r:UTF-8").read
     result_page = form.submit
     errors = result_page.search("#errorExplanation li").map{|li|li.text}
+
     if errors.any?
       print "--Error: #{pagename}: "
       puts errors
-      return (page_info ? Status::ERROR_ON_EDIT : Status::ERROR_ON_CREATE)
+      return (create ? Result::ERROR_ON_CREATE : Result::ERROR_ON_UPLOAD)
     else
       now = DateTime.now
-      pages[pagename] ||= {}
-      pages[pagename][:name] = pagename
-      pages[pagename][:url] = @wiki_base_url + "/" + URI.encode(pagename)
-      pages[pagename][:downloaded_at] = now
-      pages[pagename][:updated_at_str] = now.strftime("%Y-%m-%d")
-      write_pages_list
-      return (page_info ? Status::UPLOADED : Status::CREATED)
-    end
-  end
-
-
-  def refresh_pages_list
-    puts "Refreshing pages list"
-    @pages ||= {}
-    page = @agent.get(@wiki_base_url + "/date_index")
-
-    page.search("#content h3").each do |h3|
-      links = h3.next_element.search("a")
-      links.each do |link|
-        page_url = @config[:url] + link.attr("href")
-        pagename = URI.decode(page_url.match(/^#{@wiki_base_url}\/(.*)$/)[1]).force_encoding("UTF-8")
-        @pages[pagename] ||= {}
-        @pages[pagename][:name] = pagename
-        @pages[pagename][:url] = page_url
-        @pages[pagename][:updated_at_str] = h3.text
-      end
-    end
-
-    @pages
-  end
-
-
-  def recover_pages_list
-    @pages = YAML.load_file(@config[:pages_list_file])
-    @pages ||= {}
-  end
-
-
-  def write_pages_list
-    File.open(@config[:pages_list_file], "w+:UTF-8") do |f|
-      f.write(@pages.to_yaml)
-    end
-  end
-
-
-  def page_history(pagename)
-    puts "--Getting page history for #{pagename}" if @config[:verbose]
-    history = []
-    page = @agent.get(@wiki_base_url + "/" + URI.encode(pagename) + "/history")
-    page.search("table.wiki-page-versions tbody tr").each do |tr|
-      timestamp = DateTime.parse(tr.search("td")[3].text+"+0900") 
-      author_name = tr.search("td")[4].text.strip
-      history << {
-        :timestamp => timestamp,
-        :author_name => author_name
-      }
+      @syncstat.update(pagename, {
+        :downloaded_at => now,
+        :remote_updated_at => now
+      })
+      return (create ? Result::CREATED : Result::UPLOADED)
     end
-    history
   end
 end

data/lib/redsync/sync_stat.rb

@@ -0,0 +1,147 @@
+require 'yaml'
+require 'fileutils'
+
+class Redsync
+  class SyncStat
+    include Enumerable
+
+    def initialize(config, agent)
+      @config = config
+      @agent = agent
+
+      @file = File.join(@config[:data_dir], "__redsync_stat.yml")
+      FileUtils.touch @file unless File.exist? @file
+      @stat = YAML.load_file(@file) || {}
+    end
+
+
+    def refresh
+      puts "Refreshing pages list"
+      page = @agent.get(@config[:wiki_base_url] + "/date_index")
+      now = DateTime.now
+
+      # Get remote and local update times using remote list
+      page.search("#content h3").each do |h3|
+        links = h3.next_element.search("a")
+        links.each do |link|
+          url = @config[:url] + link.attr("href")
+          name = URI.decode(url.match(/^#{@config[:wiki_base_url]}\/(.*)$/)[1]).force_encoding("UTF-8")
+          local_file = File.join(@config[:data_dir], "#{name}.txt")
+
+          remote_updated_at = DateTime.parse(h3.text + "T00:00:00" + now.zone)
+
+          if File.exist? local_file
+            local_updated_at = File.stat(local_file).mtime.to_datetime
+            if remote_updated_at.year == now.year && remote_updated_at.month == now.month && remote_updated_at.day == now.day
+              remote_updated_at = history(name)[0][:timestamp]
+            end
+          else
+            local_updated_at = DateTime.civil
+          end
+
+          update(name, {
+            :name => name,
+            :url => url,
+            :local_file => local_file,
+            :remote_updated_at => remote_updated_at,
+            :local_updated_at => local_updated_at,
+          }, true)
+
+          update(name, {
+            :downloaded_at => local_updated_at
+          }, true) unless File.exist? local_file
+        end
+      end
+
+      # Look for new page files at local
+      Dir.entries(@config[:data_dir]).each do |file|
+        fullpath = File.join(@config[:data_dir], file)
+        next if File.directory?(fullpath)
+        next if file =~ /^__redsync_/
+        name = Iconv.iconv("UTF-8", "UTF-8-MAC", file) if RUBY_PLATFORM =~ /darwin/
+        name = name.first.match(/(.*)\.txt$/)[1]
+        next if @stat[name]
+
+        local_file = File.join(@config[:data_dir], "#{name}.txt")
+        local_updated_at = File.stat(local_file).mtime.to_datetime
+        update(name, {
+          :name => name,
+          :url => @config[:wiki_base_url] + "/#{name}",
+          :local_file => local_file,
+          :remote_updated_at => nil,
+          :local_updated_at => local_updated_at,
+          :downloaded_at => local_updated_at
+        }, true)
+      end
+
+      write
+    end
+
+
+    def history(name)
+      puts "--Getting page history for #{name}" if @config[:verbose]
+      now = DateTime.now
+      history = []
+      page = @agent.get(@config[:wiki_base_url] + "/" + URI.encode(name) + "/history")
+      page.search("table.wiki-page-versions tbody tr").each do |tr|
+        timestamp = DateTime.parse(tr.search("td")[3].text + now.zone) 
+        author_name = tr.search("td")[4].text.strip
+        history << {
+          :timestamp => timestamp,
+          :author_name => author_name
+        }
+      end
+      history
+    end
+
+    
+    def each
+      @stat.each {|k,v| yield v}
+    end
+
+
+    def for(name)
+      @stat[name]
+    end
+
+
+    def update(name, hash, suspend_write = false)
+      @stat[name] ||= {}
+      @stat[name].merge! hash
+      write unless suspend_write
+    end
+
+
+    def write
+      File.open(@file, "w+:UTF-8") do |f|
+        f.write("# DO NOT EDIT THIS FILE!\n")
+        f.write(@stat.to_yaml)
+      end
+    end
+
+
+    def new_page_names
+      self.inject([]) do |sum, page|
+        sum << page[:name] if !page[:remote_updated_at]
+        sum
+      end
+    end
+
+
+    def remote_updated_page_names
+      self.inject([]) do |sum, page|
+        sum << page[:name] if page[:remote_updated_at] && (page[:remote_updated_at] > page[:downloaded_at])
+        sum
+      end
+    end
+
+
+    def local_updated_page_names
+      self.inject([]) do |sum, page|
+        sum << page[:name] if page[:downloaded_at] && (page[:local_updated_at] > page[:downloaded_at])
+        sum
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redsync
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
-  requirement: &2153510840 !ruby/object:Gem::Requirement
+  requirement: &2160416520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153510840
+  version_requirements: *2160416520
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2153510440 !ruby/object:Gem::Requirement
+  requirement: &2160416120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153510440
+  version_requirements: *2160416120
 description: Sync Redmine's wiki pages to your local filesystem. Edit as you like,
   then upsync.
 email: merikonjatta@gmail.com
@@ -42,6 +42,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/redsync/cli.rb
+- lib/redsync/sync_stat.rb
 - lib/redsync.rb
 - README.textile
 - config.yml.dist