dash-mario 0.15

data/test/github_test.rb

@@ -0,0 +1,251 @@
+require_relative "setup"
+
+test DashFu::Mario::Github do
+  context "setup" do
+    setup { setup_source "repo"=>"assaf/vanity", "branch"=>"master" }
+
+    should "default branch to master" do
+      setup_source "repo"=>"assaf/vanity", "branch"=>" "
+      assert_equal "master", source["branch"]
+    end
+
+    context "metric" do
+      subject { metric }
+
+      should "use repository name" do
+        assert_equal "Github: assaf/vanity", subject.name
+      end
+
+      should "measure totals" do
+        assert subject.totals
+      end
+
+      should "capture commits" do
+        assert subject.columns.include?(:id=>"commits", :label=>"Commits")
+      end
+
+      should "capture watchers" do
+        assert subject.columns.include?(:id=>"watchers", :label=>"Watchers")
+      end
+
+      should "capture forks" do
+        assert subject.columns.include?(:id=>"forks", :label=>"Forks")
+      end
+    end
+  end
+
+
+  context "validation" do
+    should "raise error if repository name missing" do
+      assert_raise(RuntimeError) { setup_source "repo"=>" ", "branch"=>"master" }
+    end
+
+    should "raise error if repository name not user/repo" do
+      assert_raise(RuntimeError) { setup_source "repo"=>"vanity", "branch"=>"master" }
+    end
+
+    should "allow alphanumeric, minus and underscore" do
+      setup_source "repo"=>"assaf/the-vanity_0", "branch"=>"master"
+      assert metric.valid?
+    end
+
+    should "create valid metric" do
+      setup_source "repo"=>"assaf/vanity", "branch"=>"master"
+      assert metric.valid?
+    end
+  end
+
+
+  context "update" do
+    setup { setup_source "repo"=>"assaf/vanity", "branch"=>"master" }
+
+    should "handle 404" do
+      stub_request(:get, interactions.first.uri).to_return :status=>404
+      assert_raise(RuntimeError) { update_source }
+      assert_equal "Could not find the repository assaf/vanity", last_error
+    end
+
+    should "handle 401" do
+      stub_request(:get, interactions.first.uri).to_return :status=>401
+      assert_raise(RuntimeError) { update_source }
+      assert_equal "You are not authorized to access this repository, or invalid username/password", last_error
+    end
+
+    should "handle other error" do
+      stub_request(:get, interactions.first.uri).to_return :status=>500
+      assert_raise(RuntimeError) { update_source }
+      assert_equal "Last request didn't go as expected, trying again later", last_error
+    end
+
+    should "handle invlid document entity" do
+      stub_request(:get, interactions.first.uri).to_return :body=>"Not JSON"
+      assert_raise(RuntimeError) { update_source }
+      assert_equal "Last request didn't go as expected, trying again later", last_error
+    end
+
+    should "capture number of commits" do
+      update_source
+      assert_equal 35, totals[:commits]
+    end
+
+    should "capture number of wacthers" do
+      update_source
+      assert_equal 534, totals[:watchers]
+    end
+
+    should "capture number of forks" do
+      update_source
+      assert_equal 36, totals[:forks]
+    end
+
+    should "not create any activity" do
+      update_source
+      assert activities.empty?
+    end
+
+    context "repeating" do
+      setup do
+        update_source
+        repo = interactions.select { |i| i.uri =~ /repos\/show/ }
+        stub_request(:get, repo.first.uri).to_return :body=>repo.last.response.body
+        commits = interactions.select { |i| i.uri =~ /commits\/list/ }
+        stub_request(:get, commits.first.uri).to_return :body=>commits.last.response.body
+        update_source
+      end
+
+      should "update watchers" do
+        assert_equal 555, totals[:watchers]
+      end
+
+      should "update forks" do
+        assert_equal 38, totals[:forks]
+      end
+
+      should "capture new number of commits" do
+        assert_equal 39, totals[:commits]
+      end
+
+      context "activity" do
+        subject { activity }
+
+        should "capture commit URL" do
+          assert_equal "http://github.com/assaf/vanity/commit/dd154a9fdd2ac534b62b55b8acac2fd092d65439", subject.url
+        end
+
+        should "capture commit SHA" do
+          assert_equal "cc156a9fdd2ac534b62b55b8acac2fd092d65439", subject.uid
+        end
+
+        should "capture timestamp" do
+          assert_equal Time.parse("2010-08-06T00:22:01-07:00 UTC"), subject.timestamp
+        end
+
+        should "capture push" do
+          assert_match %{pushed to master at <a href="http://github.com/assaf/vanity">assaf/vanity</a>:}, subject.html
+        end
+
+        should "tag as push" do
+          assert_contains subject.tags, "push"
+        end
+
+        should "be valid" do
+          subject.validate
+          assert subject.valid?
+        end
+
+        context "person" do
+          subject { activity.person }
+
+          should "capture full name" do
+            assert_equal "Assaf Arkin", subject.fullname
+          end
+
+          should "capture email" do
+            assert_equal "assaf@labnotes.org", subject.email
+          end
+
+          should "capture identity" do
+            assert_contains subject.identities, "github.com:assaf"
+          end
+        end
+
+        context "commit message" do
+          subject { (Nokogiri::HTML(activity.html)/"blockquote").inner_text.strip }
+
+          should "start with commit SHA" do
+            assert_match /^cc156a9 /, subject
+          end
+
+          should "include first 50 characters of message" do
+            with_message "This is a very long message and we're only going to show the first 50 characters of it."
+            assert_equal 50, subject[/\s(.*)/, 1].length
+          end
+
+          should "use only first line of message" do
+            with_message "This message is made\nof two lines"
+            assert_match "This message is made", subject[/\s(.*)/, 1]
+          end
+
+          def with_message(message)
+            commits = interactions.select { |i| i.uri =~ /commits\/list/ }
+            commit = JSON.parse(commits.first.response.body)["commits"].first
+            commit["message"] = message
+            stub_request(:get, commits.first.uri).to_return :body=>{ :commits=>[commit] }.to_json
+            update_source
+          end
+        end
+
+        context "sequential commits" do
+          setup do
+            interaction = interactions.select { |i| i.uri =~ /commits\/list/ }.last
+            stub_request(:get, interaction.uri).to_return :body=>interaction.response.body
+            update_source
+          end
+          subject { (Nokogiri::HTML(activity.html)/"blockquote") }
+
+          should "show as multiple activities" do
+            assert_equal 3, activities.count # 4 commits -> 3 activities
+          end
+
+          should "merge related commits into single activity" do
+            assert_equal 2, subject.length   # last one has two commits
+          end
+
+          should "merge related commits in order they were listed" do
+            first, second = subject.map { |bq| bq.inner_text.strip }
+            assert_equal "cc156a9 Most recent commit", first
+            assert_equal "dd156a9 Not most recent commit", second
+          end
+        end
+      end
+
+    end
+  end
+
+
+  context "meta" do
+    setup { setup_source "repo"=>"assaf/vanity", "branch"=>"master" }
+    subject { meta }
+
+    should "link to repository" do
+      assert_contains subject, :title=>"Repository", :text=>"assaf/vanity", :url=>"http://github.com/assaf/vanity"
+    end
+
+    should "include project description" do
+      assert_contains subject, :text=>"Experiment Driven Development for Ruby"
+    end
+
+    should "link to project home page" do
+      assert_contains subject, :title=>"Home page", :url=>"http://vanity.labnotes.org"
+    end
+
+    should "list branch name" do
+      assert_contains subject, :title=>"Branch", :text=>"master"
+    end
+
+    should "show last commit message" do
+      assert_contains subject, :title=>"Commit", :text=>"Gemfile changes necessary to pass test suite.",
+        :url=>"http://github.com/assaf/vanity/commit/dd154a9fdd2ac534b62b55b8acac2fd092d6543a"
+    end
+  end
+end

data/test/helpers/activity.rb

@@ -0,0 +1,21 @@
+class Activity
+  def initialize(args = {})
+    args.each do |name, value|
+      send "#{name}=", value
+    end
+  end
+
+  attr_accessor :uid, :html, :text, :url, :timestamp, :tags, :person
+
+  def valid?
+    validate rescue return false
+    return true
+  end
+
+  def validate
+    raise "Must specify html or text" if html.blank? && text.blank?
+    raise "Tags must be alphanumeric, underscores allowed" unless tags.nil? || tags.all? { |tag| tag =~ /^[\w_]+$/ }
+    person.validate if person
+  end
+
+end

data/test/helpers/metric.rb

@@ -0,0 +1,22 @@
+class Metric
+  def initialize(args = {})
+    args.each do |name, value|
+      send "#{name}=", value
+    end
+  end
+
+  attr_accessor :name, :columns, :totals
+
+  def valid?
+    validate rescue return false
+    return true
+  end
+
+  def validate
+    fail "Metric name missing or a blank string" if name.blank?
+    fail "Metric must have at least one column" if columns.empty?
+    col_ids = columns.map { |col| col[:id] }
+    fail "All metric columns must have an id" unless col_ids.all? { |col_id| col_id }
+    fail "Metric columns must have unique ids" unless col_ids.uniq == col_ids
+  end
+end

data/test/helpers/person.rb

@@ -0,0 +1,25 @@
+class Person
+
+  def initialize(args = {})
+    args[:identities] = Array.wrap(args[:identities])
+    args.each do |name, value|
+      send "#{name}=", value
+    end
+  end
+
+  attr_accessor :fullname, :email, :identities, :photo_url
+
+  def valid?
+    validate rescue return false
+    return true
+  end
+
+  def validate
+    if photo_url
+      uri = URI.parse(photo_url)
+      fail "Photo URL must be absolute HTTP URL" unless uri.scheme == "http" && uri.absolute?
+    end
+    fail "Identities must be of the form name:value" unless identities.nil? || identities.all? { |id| id =~ /^[\w\.]+:.+$/ }
+  end
+
+end

data/test/helpers/test.rb

@@ -0,0 +1,161 @@
+# class, includes the modules DashFu::Mario::TestHelpers and Webmock, sets the
+# Mario class, and other nicities.
+#
+# @example
+#   test DashFu::Mario::RubyGems do
+#     . . .
+#   end
+def test(klass, &block)
+  Class.new(Test::Unit::TestCase).tap do |test_case|
+    test_case.class_eval do
+      include WebMock
+      include DashFu::Mario::TestHelpers
+    end
+    test_case.instance_variable_set :@mario_class, klass
+    test_case.class_eval &block
+    Object.const_set "#{klass.name.demodulize}Test", test_case
+  end
+end
+
+
+module DashFu
+  module Mario
+    module TestHelpers
+ 
+      # Default setup. If you override setup, remember to call super.
+      def setup
+        WebMock.reset_webmock
+        VCR.insert_cassette(mario_id)
+      end
+
+      # Default teardown. If you override teardown, remember to call super.
+      def teardown
+        VCR.eject_cassette
+      end
+
+      # Returns the Mario. New Mario instance for each test.
+      def mario
+        @mario ||= mario_class.new
+      end
+
+      # Sets up source using supplied parameters, also calls validate.
+      #
+      # @example
+      #   assert_raise RuntimeError do
+      #     setup_source "gem_name"=>""
+      #   end
+      # @example
+      #   setup { setup_source "gem_name"=>"vanity" }
+      def setup_source(params)
+        mario.setup source, params
+        mario.validate source
+      end
+
+      # Returns the source. New source for each test.
+      def source
+        @source ||= {}
+      end
+
+      # Updates the source. If an error occurs, raises an exception. You can get
+      # the last error message by calling #last_error.
+      def update_source(request = nil)
+        @last_error = nil
+        mario.update source, request, &updator
+      rescue
+        @last_error = $!.message
+        raise
+      end
+
+      # Last error after calling #update_source.
+      attr_reader :last_error
+
+      # Returns a new metric. See Metric.
+      #
+      # @example
+      #   assert_equal "My metric", metric.name
+      def metric
+        values = { :name=>source["metric.name"], :columns=>source["metric.columns"], :totals=>!!source["metric.totals"] }
+        Metric.new(values)
+      end
+
+      # Performs an update on the source and returns the meta-data.
+      #
+      # @example
+      #   assert meta.include?(:title=>"Version", :text=>"1.4.0")
+      def meta
+        mario.update source, nil, &updator
+        mario.meta(source)
+      end
+
+      # Returns totals collected by this source.
+      #
+      # @example
+      #   assert_equal({ :hits=>54 }, totals)
+      def totals
+        @totals ||= {}
+      end
+
+      # Returns all activities reported by this source. See Activity.
+      def activities
+        @activities ||= []
+      end
+
+      # Returns last (most recent) activity.
+      #
+      # @example
+      #   assert_equal "Pushed a new release of awesome", activity.body
+      def activity
+        activities.last
+      end
+
+      # Returns the named fixture. Fixture looked up in the file
+      # test/fixtures/<mario_id>.rb
+      def fixture(name)
+        fixtures = self.class.instance_variable_get(:@fixtures)
+        unless fixtures
+          fixtures = YAML.load_file(File.dirname(__FILE__) + "/fixtures/#{mario_id}.yml")
+          self.class.instance_variable_set :@fixtures, fixtures
+        end
+        fixtures[name]
+      end
+
+      # Returns the VCR interactions.
+      def interactions
+        VCR.current_cassette.recorded_interactions
+      end
+
+    protected
+
+      # Mario identifier (e.g. RubyGems => ruby_gems).
+      def mario_id
+        @mario_id ||= mario_class.name.demodulize.underscore
+      end
+
+      # The Mario class.
+      def mario_class
+        @mario_class ||= self.class.instance_variable_get :@mario_class
+      end
+   
+      # Source update block. 
+      def updator
+        lambda do |args|
+          if args[:set]
+            totals.update args[:set]
+          elsif args[:inc]
+            args[:inc].each do |name, value|
+              totals[name] ||= 0
+              totals[name] += value
+            end
+          elsif args[:activity]
+            values = args[:activity].clone
+            if person = values.delete(:person)
+              values[:person] = Person.new(person)
+            end
+            activities.push Activity.new(values)
+          end
+        end
+      end
+
+    end
+  end
+end