madrox 0.1.1 → 0.2.0

data/README.md

@@ -3,6 +3,8 @@
 Distributed Twitter implementation built on Git using content-less commits as
 tweets.
 
+## USAGE
+
 Madrox needs an existing repository with at a single initial commit.  "Tweets"
 are simply commits in a user-specific branch.  Use git to push/pull these 
 branches with remote git repositories.  Create custom timelines by merging
@@ -26,6 +28,10 @@ them locally.
     @rick: @bob: nada
     178f84a58ab1878d1a995ba9ce16ad11e5e58808
 
+Now, we have three tweets from two different users in their own branch.  You
+can merge these two branches into a single branch to see their commits in one
+stream:
+
     $ git branch
       bob
     * master
@@ -45,12 +51,79 @@ them locally.
     @bob: @rick: sup?
     @rick: Hi
 
+## Importing
+
+You can import tweets with the `--import` option.  You're still bound by Twitter's 3200 tweet limit, unfortunately.
+
+    $ madrox --import=twitter --since-id=123 --max-id-456 --email=EMAIL TWITTER_LOGIN
+
+    You can also use `rake console` and import the data yourself from other sources.
+
+    $ madrox --irb --email=EMAIL TWITTER_LOGIN
+    >> tweets.each do |tweet|
+    ?>   timeline.post(tweet['text'], :committed_date => Time.parse(tweet['created_at']))
+    ?> end
+
+## Ruby API
+
+The Madrox ruby API revolves around two objects:  `Madrox::Repo` and 
+`Madrox::Timeline`.
+
+`Madrox::Repo` simply tracks the Git repo.  It's used to create Timeline
+instances.
+
+    repo = Madrox::Repo.new "/path/to/repo"
+    timeline = repo.timeline('rick', 'rick@email.com')
+
+`Madrox::Timeline` represents a branch of the Git repo, and lets you post
+new messages to it.  These branches can either represent a user's timeline,
+a grouped timeline with commits merged from multiple users, or something 
+custom (such as a user's favorites).
+
+    timeline.post("Eating a sandwich.")
+
+You can list messages from a timeline.  They come out as `Grit::Commit` 
+instances.
+
+    mine = repo.timeline('me', 'my-email@email.com')
+    rick = repo.timeline('rick')
+    msg = rick.messages.first
+    msg.sha            # => 21f1ca7995b46a1008c402c92c4aa074806f92c4
+    msg.message        # => "Eating a sandwich."
+    msg.committer      # => #<Grit::Actor "rick ...">
+    msg.committed_date # => Sat Nov 6 11:48:02 -0700 2010
+
+You can add a message as a favorite:
+
+    sha = mine.fave(msg)
+    commit = mine.grit.commit(sha)
+    commit.sha            # => b1dfaf30dff279b953abc8b985bb41e247a0e50c
+    commit.message        # => "Eating a sandwich."
+    commit.committer      # => #<Grit::Actor "me ...">
+    commit.committed_date # => Sat Nov 6 12:48:02 -0700 2010
+    commit.author         # => #<Grit::Actor "rick ...">
+    commit.authored_date  # => Sat Nov 6 11:48:02 -0700 2010
+
+You can also retweet the message:
+
+    sha = mine.retweet(msg)
+    commit = mine.grit.commit(sha)
+    commit.sha            # => d1d22036741d0726901b8e555801885018e7c8df
+    commit.message        # => "Eating a sandwich."
+    commit.committer      # => #<Grit::Actor "me ...">
+    commit.committed_date # => Sat Nov 6 12:48:02 -0700 2010
+    commit.author         # => #<Grit::Actor "rick ...">
+    commit.authored_date  # => Sat Nov 6 11:48:02 -0700 2010
+
+Add your own snarky comment:
+
+    sha = mine.retweet(msg, "TMI, bro!")
+    commit = mine.grit.commit(sha)
+    commit.sha            # => 06836ee40595bf06fde3eb276a08b10ac7733a74
+    commit.message        # => "TMI, bro! RT @rick Eating a sandwich."
+
 ## TODO
 
 * Twitter pushing support
 * Git Notes for Twitter (or other) metadata.
-* Better importing.
-
-## Requirements
-
-gem install grit
+* Better importing.

data/lib/madrox.rb

@@ -1,5 +1,5 @@
 module Madrox
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'vendor', 'grit', 'lib')

data/lib/madrox/timeline.rb

@@ -21,12 +21,12 @@ module Madrox
     # Gets the Madrox object for this timeline.
     #
     # Returns a Madrox::Repo instance.
-    attr_reader   :repo
+    attr_reader :repo
 
     # Gets the Grit object for this Madrox::Repo.
     #
     # Returns a Grit::Repo instance.
-    attr_reader   :grit
+    attr_reader :grit
 
     def initialize(repo, user, email = nil)
       @user  = user
@@ -38,13 +38,27 @@ module Madrox
     # Public: Gets the messages for this timeline.  Automatically removes any 
     # merge commits.
     #
+    # options - Hash of options to filter the message output.
+    #           :max_count - Fixnum specifying the number of commits to show.  
+    #                        Default: 30.
+    #           :skip      - Fixnum specifying the number of commits to skip.
+    #           :page      - Fixnum of the current page.  This is used to 
+    #                        implicitly calculate the :skip option.  
+    #                        Default: 1
+    #
     # Returns an Array of Grit::Commit instances.
-    def messages
-      @grit.log(@user).delete_if { |commit| commit.parents.size != 1 }
+    def messages(options = {})
+      options[:no_merges]   = true
+      options[:max_count] ||= 30
+      options[:skip]      ||= begin
+        options[:max_count] * ([options.delete(:page).to_i, 1].max - 1)
+      end
+      @grit.log(@user, nil, options).
+        delete_if { |commit| commit.parents.size != 1 }
     end
 
-    # Posts the given message to the timeline.  This is a simple commit with
-    # no changed content.  Just a message.
+    # Public: Posts the given message to the timeline.  This is a simple
+    # commit with no changed content.  Just a message.
     #
     # message - String message for the timeline update.
     # options - Hash of options passed to Grit::Index#commit. 
@@ -52,14 +66,14 @@ module Madrox
     # Returns a String SHA1 of the created Git commit.
     def post(message, options = {})
       idx     = @grit.index
-      parents = [@grit.commit(@user) || @grit.commit("HEAD")]
-      parents.compact!
-      options.update(:parents => parents, :committer => actor, :head => @user)
+      options = {:committer => actor, :head => @user}.update(options)
+      options[:parents] ||= [@grit.commit(@user) || @grit.commit("HEAD")]
+      options[:parents].compact!
       @grit.index.commit(message, options)
     end
 
-    # Retweets a given commit.  The author name and date is taken from the 
-    # commit.  The message can optionally be annotated.
+    # Public: Retweets a given commit.  The author name and date is taken
+    # from the commit.  The message can optionally be annotated.
     #
     # commit  - The Grit::Commit that is being retweeted.
     # message - An optional String annotation to the retweet content.
@@ -80,6 +94,15 @@ module Madrox
         :authored_date => commit.authored_date))
     end
 
+    # Public: Marks a given commit as a favorite.  The commit is stored in a
+    # separate branch named "#{user}-favorites".  The commit's original 
+    # committed author and date remain the same, and the new commit tracks
+    # the date it was favorited.
+    def fave(commit)
+      post(commit.message, :head => "#{@user}-favorites",
+        :author => commit.author, :authored_date => commit.authored_date)
+    end
+
     # Public: Builds a Git actor object for any posted updates to this 
     # timeline.  Uses the timelines user and email.
     #

data/madrox.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'madrox'
-  s.version           = '0.1.1'
-  s.date              = '2010-10-23'
+  s.version           = '0.2.0'
+  s.date              = '2010-11-06'
   s.rubyforge_project = 'madrox'
 
   ## Make sure your summary is short. The description may be as long

data/test/timeline_test.rb

@@ -12,15 +12,31 @@ class TimelineTest < MadroxTest
 
   def test_finds_messages
     messages = @repo.timeline('merged').messages
-    assert_equal 3, messages.size
     assert_equal %w(
       f524dcedce5d4f20f3a1d2ecb79f63c8d175d85f 
       e28333e7c6f42004d7d619a1b485072e6361da94 
       cd45ac1b461450245fc104aea0506da6fab1db72), messages.map { |m| m.sha }
   end
 
+  def test_finds_paginated_messages
+    messages = @repo.timeline('merged').messages :page => 1, :max_count => 1
+    assert_equal %w(
+      f524dcedce5d4f20f3a1d2ecb79f63c8d175d85f), messages.map { |m| m.sha }
+
+    messages = @repo.timeline('merged').messages :page => 3, :max_count => 1
+    assert_equal %w(
+      cd45ac1b461450245fc104aea0506da6fab1db72), messages.map { |m| m.sha }
+  end
+
+  def test_skips_messages
+    messages = @repo.timeline('merged').messages :skip => 1
+    assert_equal %w(
+      e28333e7c6f42004d7d619a1b485072e6361da94 
+      cd45ac1b461450245fc104aea0506da6fab1db72), messages.map { |m| m.sha }
+  end
+
   def test_posts_commit
-    @repo = fork_git_fixture(:simple)
+    @repo    = fork_git_fixture(:simple)
     timeline = @repo.timeline('user2', 'user2@email.com')
     assert_equal %w(e28333e7c6f42004d7d619a1b485072e6361da94), 
       timeline.messages.map { |m| m.sha }
@@ -32,7 +48,7 @@ class TimelineTest < MadroxTest
   def test_posts_commit_from_date
     @repo    = fork_git_fixture(:simple)
     timeline = @repo.timeline('user2', 'user2@email.com')
-    sha      = timeline.post('hi', :committed_date => Time.utc(2000))
+    sha      = timeline.post('hi', :committed_date => Time.utc(2000, 2))
     commit   = @repo.grit.commit(sha)
     assert_equal 2000, commit.committed_date.year
   end
@@ -42,7 +58,7 @@ class TimelineTest < MadroxTest
     timeline1 = @repo.timeline('user1')
     timeline2 = @repo.timeline('user2')
     original  = timeline1.messages.last
-    sha       = timeline2.retweet(original, :committed_date => Time.utc(2000))
+    sha       = timeline2.retweet(original, :committed_date => Time.utc(2000, 2))
     retweet   = @repo.grit.commit(sha)
     assert_equal 1287750442,       retweet.authored_date.to_i
     assert_equal 2000,             retweet.committed_date.year
@@ -52,11 +68,11 @@ class TimelineTest < MadroxTest
   end
 
   def test_retweets_with_annotation
-    @repo    = fork_git_fixture(:simple)
+    @repo     = fork_git_fixture(:simple)
     timeline1 = @repo.timeline('user1')
     timeline2 = @repo.timeline('user2')
     original  = timeline1.messages.last
-    sha       = timeline2.retweet(original, 'sweet!', :committed_date => Time.utc(2000))
+    sha       = timeline2.retweet(original, 'sweet!', :committed_date => Time.utc(2000, 2))
     retweet   = @repo.grit.commit(sha)
     assert_equal 1287750442, retweet.authored_date.to_i
     assert_equal 2000,       retweet.committed_date.year
@@ -64,4 +80,19 @@ class TimelineTest < MadroxTest
     assert_equal 'user2',    retweet.committer.name
     assert_equal "sweet! RT @user1 #{original.message}", retweet.message
   end
+
+  def test_favoriting_a_tweet
+    @repo     = fork_git_fixture(:simple)
+    timeline1 = @repo.timeline('user1')
+    timeline2 = @repo.timeline('user2')
+    original  = timeline2.messages.last
+
+    assert_nil @repo.grit.commit('user1-favorites')
+    sha  = timeline1.fave(original)
+    fave = @repo.grit.commit(sha)
+    assert_equal 'user1', fave.committer.name
+    assert_equal 'user2', fave.author.name
+
+    assert_equal sha, @repo.grit.commit('user1-favorites').sha
+  end
 end

data/vendor/grit/History.txt

@@ -4,6 +4,7 @@
     * Add `git cat-file --batch` support with Grit::Repo#batch.
   * Minor Enhancements
     * Grit::Index#commit supports custom committer/author names and dates.
+    * Performance enhancements with internal command output buffering.
   * Bug Fixes
     * Zero-Padding issue in Grit::Index was fixed.
 

data/vendor/grit/lib/grit/actor.rb

@@ -40,7 +40,7 @@ module Grit
       end
       hours = (time.utc_offset.to_f / 3600).to_i # 60 * 60, seconds to hours
       rem   = time.utc_offset.abs % 3600
-      out << " #{time.to_i} #{hours >= 0 ? :+ : :-}#{hours.to_s.rjust(2, '0')}#{rem.to_s.rjust(2, '0')}"
+      out << " #{time.to_i} #{hours >= 0 ? :+ : :-}#{hours.abs.to_s.rjust(2, '0')}#{rem.to_s.rjust(2, '0')}"
     end
 
     # Pretty object inspection

data/vendor/grit/lib/grit/git-ruby/internal/pack.rb

@@ -317,7 +317,7 @@ module Grit
               if indata.size == 0
                 raise PackFormatError, 'error reading pack data'
               end
-              outdata += zstr.inflate(indata)
+              outdata << zstr.inflate(indata)
             end
             if outdata.size > destsize
               raise PackFormatError, 'error reading pack data'
@@ -351,9 +351,9 @@ module Grit
               cp_size |= delta.getord(pos += 1) << 16 if c & 0x40 != 0
               cp_size = 0x10000 if cp_size == 0
               pos += 1
-              dest += base[cp_off,cp_size]
+              dest << base[cp_off,cp_size]
             elsif c != 0
-              dest += delta[pos,c]
+              dest << delta[pos,c]
               pos += c
             else
               raise PackFormatError, 'invalid delta data'

data/vendor/grit/lib/grit/git.rb

@@ -255,40 +255,35 @@ module Grit
 
     def sh(command, &block)
       ret, err = '', ''
+      max = self.class.git_max_size
       Open3.popen3(command) do |stdin, stdout, stderr|
         block.call(stdin) if block
         Timeout.timeout(self.class.git_timeout) do
-          while tmp = stdout.read(1024)
-            ret += tmp
-            if (@bytes_read += tmp.size) > self.class.git_max_size
-              bytes = @bytes_read
-              @bytes_read = 0
-              raise GitTimeout.new(command, bytes)
-            end
+          while tmp = stdout.read(8192)
+            ret << tmp
+            raise GitTimeout.new(command, ret.size) if ret.size > max
           end
         end
 
-        while tmp = stderr.read(1024)
-          err += tmp
+        while tmp = stderr.read(8192)
+          err << tmp
         end
       end
       [ret, err]
     rescue Timeout::Error, Grit::Git::GitTimeout
-      bytes = @bytes_read
-      @bytes_read = 0
-      raise GitTimeout.new(command, bytes)
+      raise GitTimeout.new(command, ret.size)
     end
 
     def wild_sh(command, &block)
       ret, err = '', ''
       Open3.popen3(command) do |stdin, stdout, stderr|
         block.call(stdin) if block
-        while tmp = stdout.read(1024)
-          ret += tmp
+        while tmp = stdout.read(8192)
+          ret << tmp
         end
 
-        while tmp = stderr.read(1024)
-          err += tmp
+        while tmp = stderr.read(8192)
+          err << tmp
         end
       end
       [ret, err]

data/vendor/grit/lib/grit/index.rb

@@ -98,15 +98,19 @@ module Grit
     # Returns a String of the SHA1 of the new commit.
     def commit(message, parents = nil, actor = nil, last_tree = nil, head = 'master')
       if parents.is_a?(Hash)
-        committer      = parents[:committer] || parents[:actor]
+        actor          = parents[:actor]
+        committer      = parents[:committer]
         author         = parents[:author]
         last_tree      = parents[:last_tree]
         head           = parents[:head]
         committed_date = parents[:committed_date]
         authored_date  = parents[:authored_date]
-        parents        = parents[:parents] || []
+        parents        = parents[:parents]
       end
 
+      committer ||= actor
+      author    ||= committer
+
       tree_sha1 = write_tree(self.tree, self.current_tree)
 
       # don't write identical commits

data/vendor/grit/test/test_actor.rb

@@ -5,6 +5,14 @@ class TestActor < Test::Unit::TestCase
 
   end
 
+  # output
+  def test_output_adds_tz_offset
+    t = Time.now
+    a = Actor.new("Tom Werner", "tom@example.com")
+    assert_equal "Tom Werner <tom@example.com> #{t.to_i} -0700", 
+      a.output(t)
+  end
+
   # from_string
 
   def test_from_string_should_separate_name_and_email

data/vendor/grit/test/test_git.rb

@@ -49,9 +49,8 @@ class TestGit < Test::Unit::TestCase
   end
 
   def test_raises_if_too_many_bytes
-    @git.instance_variable_set(:@bytes_read, 6000000)
     assert_raises Grit::Git::GitTimeout do
-      @git.version
+      @git.sh "yes | head -#{Grit::Git.git_max_size + 1}"
     end
   end
 

data/vendor/grit/test/test_rubygit_index.rb

@@ -32,11 +32,20 @@ class TestRubyGitIndex < Test::Unit::TestCase
     assert_equal now.day,   commit.committed_date.day
   end
 
+  def test_set_actor
+    parents = [@git.commits.first]
+    sha     = @git.index.commit('message', parents, @user)
+
+    commit  = @git.commit(sha)
+    assert_equal @user.name, commit.committer.name
+    assert_equal @user.name, commit.author.name
+  end
+
   def test_allow_custom_committed_and_authored_dates
     parents = [@git.commits.first]
     sha     = @git.index.commit 'message', 
-                :committed_date => Time.utc(2000),
-                :authored_date  => Time.utc(2001),
+                :committed_date => Time.local(2000),
+                :authored_date  => Time.local(2001),
                 :parents        => parents, 
                 :actor          => @user, 
                 :head           => 'master'
@@ -52,10 +61,11 @@ class TestRubyGitIndex < Test::Unit::TestCase
     sha     = @git.index.commit 'message', 
                 :committer => Grit::Actor.new('abc', nil),
                 :author    => Grit::Actor.new('def', nil),
-                :parents        => parents, 
-                :head           => 'master'
+                :parents   => parents, 
+                :head      => 'master'
 
     commit  = @git.commit(sha)
+    assert_equal parents.map { |c| c.sha }, commit.parents.map { |c| c.sha }
     assert_equal 'abc', commit.committer.name
     assert_equal 'def', commit.author.name
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rick Olson
@@ -14,14 +14,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-23 00:00:00 +02:00
+date: 2010-11-06 00:00:00 -07:00
 default_executable: madrox
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: yajl-ruby
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -1505,7 +1504,6 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -1513,7 +1511,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -1523,7 +1520,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: madrox
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 2
 summary: Distributed Twitter implementation on Git.