metior 0.1.4 → 0.2.0

data/lib/metior/github/commit.rb

@@ -6,8 +6,6 @@
 require 'time'
 
 require 'metior/commit'
-require 'metior/github'
-require 'metior/github/actor'
 
 module Metior
 
@@ -18,16 +16,13 @@ module Metior
     # @author Sebastian Staudt
     class Commit < Metior::Commit
 
-      include Metior::GitHub
-
       # Creates a new GitHub commit object linked to the repository and branch
       # it belongs to and the data parsed from the corresponding JSON data
       #
       # @param [Repository] repo The GitHub repository this commit belongs to
-      # @param [String] range The commit range this commits belongs to
       # @param [Hashie:Mash] commit The commit data parsed from the JSON API
-      def initialize(repo, range, commit)
-        super repo, range
+      def initialize(repo, commit)
+        super repo
 
         @added_files    = []
         @additions      = 0
@@ -38,16 +33,10 @@ module Metior
         @id             = commit.id
         @message        = commit.message
         @modified_files = []
+        @parents        = commit.parents.map { |parent| parent.id }
 
-        authors = repo.authors range
-        @author = authors[Actor.id_for commit.author]
-        @author = Actor.new repo, commit.author if author.nil?
-        @author.add_commit self
-
-        committers = repo.committers range
-        @committer = committers[Actor.id_for commit.committer]
-        @committer = Actor.new repo, commit.committer if @committer.nil?
-        @committer.add_commit self
+        self.author    = commit.author
+        self.committer = commit.committer
       end
 
     end

data/lib/metior/github/repository.rb

@@ -5,8 +5,6 @@
 
 require 'octokit'
 
-require 'metior/github'
-require 'metior/github/commit'
 require 'metior/repository'
 
 module Metior
@@ -18,8 +16,6 @@ module Metior
     # @author Sebastian Staudt
     class Repository < Metior::Repository
 
-      include Metior::GitHub
-
       # @return [String] The project name of the repository
       attr_reader :project
 
@@ -31,23 +27,42 @@ module Metior
       #
       # @param [String] user The GitHub username of repository's owner
       # @param [String] project The name of the project
-      def initialize(user, project)
+      def initialize(user, project = nil)
+        user, project = user.split('/') if user.include? '/'
+
         super "#{user}/#{project}"
 
-        @project = project
-        @user    = user
+        @project     = project
+        @user        = user
       end
 
       private
 
+      # Returns the unique identifier for the commit the given reference – like
+      # a branch name – is pointing to
+      #
+      # Returns the given ref name immediately if it is a full SHA1 commit ID.
+      #
+      # @param [String] ref A symbolic reference name
+      # @return [String] The SHA1 ID of the commit the reference is pointing to
+      def id_for_ref(ref)
+        return ref if ref.match(/[0-9a-f]{40}/)
+        @refs[ref] = Octokit.commit(@path, ref).id unless @refs.key? ref
+        @refs[ref]
+      end
+
+      # Loads all branches and the corresponding commit IDs of this repository
+      #
+      # @return [Hash<String, String>] The names of all branches and the
+      #         corresponding commit IDs
+      # @see Octokit#branches
+      def load_branches
+        Octokit.branches(@path)
+      end
+
       # This method uses Octokit to load all commits from the given commit
       # range
       #
-      # If you want to compare a branch with another (i.e. if you supply a
-      # range of commits), it needs two calls to the GitHub API to get all
-      # commits of each branch. The comparison is done in the code, so the
-      # limits (see below) will be effectively cut in half.
-      #
       # @note GitHub API is currently limited to 60 calls a minute, so you
       #       won't be able to query branches with more than 2100 commits
       #       (35 commits per call).
@@ -56,42 +71,55 @@ module Metior
       #        (`'master..development'`), a range (`'master'..'development'`)
       #        or as a single ref (`'master'`). A single ref name means all
       #        commits reachable from that ref.
-      # @return [Array<Commit>] All commits in the given commit range
-      # @see #load_ref_commits
-      def load_commits(range)
-        commits      = load_ref_commits(range.last)
-        if range.first == ''
-          base_commits = []
-        else
-          base_commits = load_ref_commits(range.first).map! do |commit|
-            commit.id
-          end
-        end
-        commits.reject { |commit| base_commits.include? commit.id }
-      end
-
-      # This method uses Octokit to load all commits from the given ref
-      #
-      # Because of GitHub API limitations, the commits have to be loaded in
-      # batches.
-      #
-      # @note GitHub API is currently limited to 60 calls a minute, so you
-      #       won't be able to query refs with more than 2100 commits (35
-      #       commits per call).
-      # @param [String] ref The ref to load commits from
-      # @return [Array<Commit>] All commits from the given ref
+      # @return [Hashie::Mash, nil] The base commit of the requested range or
+      #         `nil` if the the range starts at the beginning of the history
+      # @return [Array<Hashie::Mash>] All commits in the given commit range
       # @see Octokit::Commits#commits
-      def load_ref_commits(ref)
+      def load_commits(range)
+        base_commit = nil
         commits = []
         page = 1
         begin
           loop do
-            commits += Octokit.commits(@path, ref, :page => page)
+            new_commits = Octokit.commits(@path, range.last, :page => page)
+            base_commit_index = new_commits.find_index do |commit|
+              commit.id == range.first
+            end
+            unless base_commit_index.nil?
+              commits += new_commits[0..base_commit_index-1]
+              base_commit = new_commits[base_commit_index]
+              break
+            end
+            commits += new_commits
             page += 1
           end
-        rescue Octokit::NotFound, Faraday::Error::ResourceNotFound
+        rescue Octokit::NotFound
         end
-        commits
+
+        [base_commit, commits]
+      end
+
+      # Loads both the name and description of the project contained in the
+      # repository from GitHub
+      #
+      # @see #description
+      # @see #name
+      # @see Octokit.repo
+      def load_name_and_description
+        github_repo  = Octokit.repo @path
+        @description = github_repo.description
+        @name        = github_repo.name
+      end
+      alias_method :load_description, :load_name_and_description
+      alias_method :load_name, :load_name_and_description
+
+      # Loads all tags and the corresponding commit IDs of this repository
+      #
+      # @return [Hash<String, String>] The names of all tags and the
+      #         corresponding commit IDs
+      # @see Octokit#tags
+      def load_tags
+        Octokit.tags @path
       end
 
     end

data/lib/metior/report.rb

@@ -0,0 +1,139 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'fileutils'
+require 'mustache'
+
+require 'metior/report/view'
+
+module Metior
+
+  # This class represents a report
+  #
+  # A report is a collection of Mustache views that have access to the
+  # repository attached to this report.
+  #
+  # @author Sebastian Staudt
+  # @see View
+  class Report
+
+    # The path where the reports bundled with Metior live
+    REPORTS_PATH = File.expand_path File.join File.dirname(__FILE__), '..', '..', 'reports'
+
+    # Returns the range of commits that should be analyzed by this report
+    #
+    # @return [String, Range] The range of commits covered by this report
+    attr_reader :range
+
+    # Returns the repository that should be analyzed by this report
+    #
+    # @return [Repository] The repository attached to this report
+    attr_reader :repository
+
+    # Create a new report instance for the given report name, repository and
+    # commit range
+    #
+    # @param [String, Symbol] name The name of the report to load and
+    #        initialize
+    # @param [Repository] repository The repository to analyze
+    # @param [String, Range] range The commit range to analyze
+    def self.create(name, repository, range = repository.vcs::DEFAULT_BRANCH)
+      require File.join(REPORTS_PATH, name.to_s)
+      name = name.to_s.split('_').map { |n| n.capitalize }.join('')
+      const_get(name.to_sym).new(repository, range)
+    end
+
+    # Returns the name of this report
+    #
+    # @return [String] The name of this report
+    def self.name
+      class_variable_get(:@@name).to_s
+    end
+
+    # Returns the file system path this report resides in
+    #
+    # @return [String] The path of this report
+    def self.path
+      File.join REPORTS_PATH, name
+    end
+
+    # Returns the file system path this report's templates reside in
+    #
+    # @return [String] The path of this report's templates
+    def self.template_path
+      File.join path, 'templates'
+    end
+
+    # Returns the file system path this report's views reside in
+    #
+    # @return [String] The path of this report's views
+    def self.view_path
+      File.join path, 'views'
+    end
+
+    # Returns the symbolic names of the main views this report consists of
+    #
+    # @reeturn [Array<Symbol>] This report's views
+    def self.views
+      class_variable_get :@@views
+    end
+
+    # Creates a new report for the given repository and commit range
+    #
+    # @param [Repository] repository The repository to analyze
+    # @param [String, Range] range The commit range to analyze
+    def initialize(repository, range = repository.vcs::DEFAULT_BRANCH)
+      @range      = range
+      @repository = repository
+    end
+
+    # Generates this report's output into the given target directory
+    #
+    # This will generate individual HTML files for the main views of the
+    # report.
+    #
+    # @param [String] target_dir The target directory of the report
+    def generate(target_dir)
+      target_dir = File.expand_path target_dir
+      copy_assets(target_dir)
+
+      Mustache.template_path  = self.class.template_path
+      Mustache.view_path      = self.class.view_path
+      Mustache.view_namespace = self.class
+
+      self.class.views.each do |view_name|
+        file_name = File.join target_dir, view_name.to_s.downcase + '.html'
+        begin
+          output_file = File.open file_name, 'w'
+          output_file.write Mustache.view_class(view_name).new(self).render
+        ensure
+          output_file.close
+        end
+      end
+    end
+
+    private
+
+    # Copies the assets coming with this report to the given target directory
+    #
+    # This will copy the contents of the `images`, `javascript` and
+    # `stylesheets` directories inside the report's path into the target
+    # directory.
+    #
+    # @param [String] target_dir The target directory of the report
+    def copy_assets(target_dir)
+      FileUtils.mkdir_p target_dir
+
+      %w{images javascripts stylesheets}.map do |type|
+        File.join(self.class.path, type)
+      end.each do |src|
+        next unless File.directory? src
+        FileUtils.cp_r src, target_dir
+      end
+    end
+
+  end
+
+end

data/lib/metior/report/view.rb

@@ -0,0 +1,120 @@
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
+#
+# Copyright (c) 2011, Sebastian Staudt
+
+require 'metior/report/view_helper'
+
+class Metior::Report
+
+  # This class is an extended Mustache view
+  #
+  # A view represents a whole page or a section of a page that displays
+  # information about a repository. It is always attached to a specific report
+  # and can access the information of the report and the repository.
+  #
+  # @author Sebastian Staudt
+  class View < Mustache
+
+    include ViewHelper
+
+    # This will initialize new view classes
+    #
+    # @param [Class] subclass The inheriting view class
+    def self.inherited(subclass)
+      subclass.send :class_variable_set, :@@required_features, []
+    end
+
+    # Specifies one or more VCS features that are required to generate this
+    # view
+    #
+    # @example
+    #   class LineStatsView < View
+    #
+    #     requires :line_stats
+    #
+    #     ...
+    #
+    #   end
+    # @param [Symbol, ...] features One ore more features that are required for
+    #        this view
+    def self.requires(*features)
+      required_features = class_variable_get :@@required_features
+      required_features += features
+      class_variable_set :@@required_features, required_features
+    end
+
+    # Initializes this view with the given report
+    #
+    # @param [Report] report The report this view belongs to
+    def initialize(report)
+      @report = report
+    end
+
+    # This will try to render a view as a partial of the current view or call a
+    # method of the repository
+    #
+    # The partial view will either be aquired from the current view namespace,
+    # i.e. the report this view belongs to, or from the default report.
+    #
+    # @param [Symbol] name The name of the view to render or the repository
+    #        method to call
+    # @param [Object, ...] args The arguments to pass to the method
+    # @param [Proc] block The block to pass to the method
+    # @see Default
+    # @see http://rubydoc.info/gems/mustache/Mustache#view_class-class_method
+    #      Mustache.view_class
+    def method_missing(name, *args, &block)
+      view_class = Mustache.view_class name
+      return view_class.new(@report).render if view_class != Mustache
+
+      repository.send name, *args, &block
+    end
+
+    # This checks if all required VCS features of this view are available for
+    # this report's repository
+    #
+    # @param [Object, ...] args The arguments expected by {Mustache#render}
+    # @see .requires
+    # @see http://rubydoc.info/gems/mustache/Mustache#render-instance_method
+    #      Mustache#render
+    def render(*args)
+      features = self.class.send :class_variable_get, :@@required_features
+      super if features.all? { |feature| repository.supports? feature }
+    end
+
+    # Returns the repository that is analyzed by the report this view belongs
+    # to
+    #
+    # @return [Repository] The repository belonging to this view's report
+    def repository
+      @report.repository
+    end
+
+    # Returns whether the given name refers a partial view that can be rendered
+    # or method that can be called
+    #
+    # This checks whether this view has a method with the given name, or if
+    # another view with this name exists, or if the repository has a method
+    # with this name.
+    #
+    # @param [Symbol] name The name of the partial or method
+    # @return [Boolean] `true` if the given name refers a partial or method
+    # @see http://rubydoc.info/gems/mustache/Mustache#view_class-class_method
+    #      Mustache.view_class
+    def respond_to?(name)
+      methods.include?(name.to_s) ||
+      Mustache.view_class(name) != Mustache ||
+      repository.respond_to?(name)
+    end
+
+    # Returns the name of the VCS the analyzed repository is using
+    #
+    # @return [Symbol] The name of the current VCS
+    def vcs_name
+      repository.vcs::NAME
+    end
+
+  end
+
+end