ginatra 3.0.1 → 4.0.0

data/lib/ginatra/config.rb

@@ -1,130 +1,27 @@
-require "yaml"
-require "fileutils"
-require "logger"
+require 'yaml'
+require 'ostruct'
 
 module Ginatra
+  def self.config
+    @config ||= OpenStruct.new load_config
+  end
 
-  # A Wrapper for the ginatra configuration variables,
-  # including methods to load, dump and lookup keys
-  # using just the class.
-  class Config
-
-    current_path = File.expand_path("#{File.dirname(__FILE__)}")
-
-    # A default path for our configuration variables!
-    CONFIG_PATH = File.expand_path("~/.ginatra/config.yml")
-
-    # A default config that we fall back to if no file is found.
-    DEFAULT_CONFIG = {
-      :git_dirs => [File.expand_path("#{current_path}/../../repos/*")],
-      :ignored_files => ['README.md'],
-      :description => "View My Git Repositories",
-      :port => 9797,
-      :host => "0.0.0.0",
-      :prefix => "/"
-    }
-
-    def self.logger
-      return @logger if @logger
-
-      log_file = Ginatra::Config[:log_file] || STDOUT
-
-      # create log_file location
-      # The log_file config option should be an absolute file system path
-      # It doesn't have to exist, but ginatra should have the proper file system privileges to create the directories
-      # and files along the specified path
-      unless log_file == STDOUT
-        parent_dir, separator, file_component = log_file.rpartition("/")
-        FileUtils.mkdir_p parent_dir
-        FileUtils.touch log_file
-      end
-
-      # determine log level from config file
-      # The log_level config option should be one of the Logger::Severity constant names (case doesn't matter)
-      # example: :log_level: debug
-      log_level = Ginatra::Config[:log_level]
-
-      if log_level.nil?
-        log_level = Logger::WARN
-      else
-        log_level = Logger.const_get(log_level.to_s.upcase.to_sym)
-        log_level = Logger::WARN if log_level.nil?
-      end
-
-      @logger = Logger.new(log_file)
-      @logger.level     = log_level
-      @logger.formatter = Proc.new {|s, t, n, msg| "[#{t}] #{msg}\n"}
-      @logger
-    end
-
-    def self.safe_setup
-      unless File.exist?(CONFIG_PATH)
-        FileUtils.mkdir_p(File.dirname(CONFIG_PATH))
-        File.open(CONFIG_PATH, 'w') do |f|
-          YAML.dump(DEFAULT_CONFIG, f)
-        end
-      end
-    end
-
-    # Loads the configuration and merges it with
-    # the default configuration.
-    #
-    # @return [Hash] config a hash of the configuration options
-    def self.load!
-      loaded_config = {}
-      @config = DEFAULT_CONFIG.dup
-      if File.size(CONFIG_PATH) == 0
-        dump!
-      else
-        loaded_config = YAML.load_file(CONFIG_PATH)
-        @config.merge!(loaded_config)
-      end
-      @config
-    end
-
-    # Dumps the _current_ configuration to +CONFIG_PATH+
-    # again WITHOUT regard for what's already there.
-    #
-    # Very Destructive Method. Use with care!
-    def self.dump!
-      File.open(CONFIG_PATH, 'w') do |f|
-        YAML.dump(@config, f)
-      end
-    end
+  # Loads the configuration and merges it with
+  # custom configuration if necessary.
+  #
+  # @return [Hash] config a hash of the configuration options
+  def self.load_config
+    current_path        = File.expand_path(File.dirname(__FILE__))
+    custom_config_file  = File.expand_path("~/.ginatra/config.yml")
+    default_config_file = File.expand_path("#{current_path}/../../config.yml")
 
-    # Allows us to do many things.
-    #
-    # The first is respond to any hash methods
-    # and execute them on the +@config+ hash.
-    #
-    # The second is to do something like
-    # +Ginatra::Config.port+ instead of something
-    # like +Ginatra::Config[:port]+
-    #
-    # @return depends on what's in the config hash.
-    def self.method_missing(sym, *args, &block)
-      if @config.respond_to?(sym)
-        @config.send(sym, *args, &block)
-      elsif @config.has_key?(sym)
-        @config[sym]
-      else
-        super
-      end
-    end
+    config = YAML.load_file(default_config_file)
 
-    # This is so that we can be clever by using
-    # +#try()+ and so that this mirrors +method_missing+.
-    #
-    # @see Ginatra::Config.method_missing
-    def self.respond_to?(name)
-      if @config.respond_to?(name)
-        true
-      elsif @config.has_key?(name)
-        true
-      else
-        super
-      end
+    if File.exist?(custom_config_file)
+      custom_config = YAML.load_file(custom_config_file)
+      config.merge!(custom_config)
     end
 
+    config
   end
 end

data/lib/ginatra/errors.rb

@@ -0,0 +1,10 @@
+module Ginatra
+  # A standard error class for inheritance.
+  class Error < StandardError; end
+
+  # Raised when repo not found in list.
+  class RepoNotFound < Error; end
+
+  # Raised when repo ref not found.
+  class InvalidRef < Error; end
+end

data/lib/ginatra/helpers.rb

@@ -1,30 +1,89 @@
-require "digest/md5"
+require 'digest/md5'
 
 module Ginatra
-  # Helpers used in the views usually,
-  # but not exclusively.
+  # Helpers used in the views, and not only.
   module Helpers
+    # Escapes string to HTML entities
+    def h(text)
+      Rack::Utils.escape_html(text)
+    end
+
+    # Checks X-PJAX header
+    def is_pjax?
+      request.env['HTTP_X_PJAX']
+    end
 
-    # constructs the URL used in the layout's base tag
-    def prefix_url(rest_of_url="")
-      prefix = Ginatra::Config[:prefix].to_s
+    # Sets title for pages
+    def title(*args)
+      @title ||= []
+      @title_options ||= { headline: nil, sitename: nil }
+      options = args.last.is_a?(Hash) ? args.pop : {}
 
-      if prefix.length > 0 && prefix[-1].chr == "/"
+      @title += args
+      @title_options.merge!(options)
+
+      t = @title.clone
+      t << @title_options[:headline]
+      t << @title_options[:sitename]
+      t.compact.join ' - '
+    end
+
+    # Constructs the URL used in the layout's base tag
+    def prefix_url(rest_of_url='')
+      prefix = Ginatra.config.prefix.to_s
+
+      if prefix.length > 0 && prefix[-1].chr == '/'
         prefix.chop!
       end
 
       "#{prefix}/#{rest_of_url}"
     end
 
-    # takes an email and returns a url to a secure gravatar
+    # Returns hint to set repository description
+    def empty_description_hint_for(repo)
+      return '' unless repo.description.empty?
+      hint_text = "Edit `#{repo.path}description` file to set the repository description."
+      "<span class='icon-exclamation-sign' title='#{hint_text}'></span>"
+    end
+
+    # Returns file icon depending on filemode
+    def file_icon(filemode)
+      case filemode
+        # symbolic link (120000)
+        when 40960 then "<span class='icon-share-alt'></span>"
+        # executable file (100755)
+        when 33261 then "<span class='icon-asterisk'></span>"
+        else "<span class='icon-file'></span>"
+      end
+    end
+
+    # Masks original email
+    def secure_mail(email)
+      local, domain = email.split('@')
+      "#{local[0..3]}...@#{domain}"
+    end
+
+    # Takes an email and returns an image tag with gravatar
     #
     # @param [String] email the email address
-    # @return [String] the url to the gravatar
-    def gravatar_url(email)
-      "https://secure.gravatar.com/avatar/#{Digest::MD5.hexdigest(email)}?s=40"
+    # @param [Hash] options alt, class and size options for image tag
+    # @return [String] html image tag
+    def gravatar_image_tag(email, options={})
+      alt = options.fetch(:alt, email.gsub(/@\S*/, ''))
+      size = options.fetch(:size, 40)
+      url = "https://secure.gravatar.com/avatar/#{Digest::MD5.hexdigest(email)}?s=#{size}"
+
+      if options[:lazy]
+        placeholder = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7'
+        tag = "<img data-original='#{url}' src='#{placeholder}' alt='#{h alt}' height='#{size}' width='#{size}' class='js-lazy #{options[:class]}'>"
+      else
+        tag = "<img src='#{url}' alt='#{h alt}' height='#{size}' width='#{size}'#{" class='#{options[:class]}'" if options[:class]}>"
+      end
+
+      tag
     end
 
-    # reformats the date into a user friendly date with html entities
+    # Reformats the date into a user friendly date with html entities
     #
     # @param [#strftime] date object to format nicely
     # @return [String] html string formatted using
@@ -33,116 +92,118 @@ module Ginatra
       date.strftime("%b %d, %Y &ndash; %H:%M")
     end
 
-    # displays the actor box easily.
-    #
-    # Internally, it calls the +#partial+ method
-    # @see Sinatra::Partials#partial
-    #
-    # @param [Grit::Actor] actor the Grit Actor Object
-    # @param [#to_s] role the role that the object has.
-    # @param [#strftime] date the date that the actor acted on.
+    # Returns an html time tag for the given time
     #
-    # @return [String] a string that contains the box for the actor.
-    def actor_box(actor, role, date)
-      partial(:actor_box, :locals => { :actor => actor, :role => role, :date => date })
+    # @param [Time] time object
+    # @return [String] time tag formatted using
+    #   +"%B %d, %Y %H:%M"+
+    def time_tag(time)
+      datetime = time.strftime('%Y-%m-%dT%H:%M:%S%z')
+      title = time.strftime('%Y-%m-%d %H:%M:%S')
+      "<time datetime='#{datetime}' title='#{title}'>#{time.strftime('%B %d, %Y %H:%M')}</time>"
     end
 
-    # works out what actor boxes need to be displayed.
+    # Returns a string including the link to download a patch for a certain
+    # commit to the repo
     #
-    # Will always display the committer box, and will only display
-    # the author box if it's different to the committer
+    # @param [Rugged::Commit] commit the commit you want a patch for
+    # @param [String] repo_param the url-sanitised name for the repo
+    #   (for the link path)
     #
-    # @param [Grit::Commit] commit the commit in question
-    # @return [String] a string representing the HTML actor boxes
-    def actor_boxes(commit)
-      o = actor_box(commit.committer, :committer, commit.committed_date)
-      if commit.author.name != commit.committer.name
-        o = actor_box(commit.author, :author, commit.authored_date) + o
-      end
+    # @return [String] the HTML link to the patch
+    def patch_link(commit, repo_param)
+      patch_url = prefix_url("#{repo_param}/commit/#{commit.oid}.patch")
+      "<a href='#{patch_url}'>Download Patch</a>"
     end
 
-    # spits out a link to a certain reference.
+    # Spits out a HTML link to the atom feed for a given ref of a given repo
     #
-    # @param [Grit::Ref] ref grit ref object
-    # @param [String] repo_param the url-sanitised-name for the repo
-    #   (for the link path)
+    # @param [Sting] repo_param the url-sanitised-name of a given repo
+    # @param [String] ref the ref to link to.
     #
-    # @return [String] HTML link to the given ref with class attached.
-    def commit_ref(ref, repo_param)
-      ref_class = ref.class.to_s.split("::")[1].to_s
-      "<a class=\"ref #{ref_class}\" href=\"" + prefix_url("#{repo_param}/#{ref.name}") + "\">#{ref.name}</a>"
+    # @return [String] the HTML containing the link to the feed.
+    def atom_feed_url(repo_param, ref=nil)
+      ref.nil? ? prefix_url("#{repo_param}.atom") : prefix_url("#{repo_param}/#{ref}.atom")
     end
 
-    # calls +Ginatra::Helpers#commit_ref+ for each ref in the commit
+    # Returns a HTML (+<ul>+) list of the files modified in a given commit.
     #
-    # @see Ginatra::Helpers#commit_ref
+    # It includes classes for added/modified/deleted and also anchor links
+    # to the diffs for further down the page.
     #
-    # @param [Grit::Commit] commit grit commit object
-    # @param [String] repo_param the url-sanitised-name for the repo
-    #   (for the link path)
+    # @param [Rugged::Commit] commit the commit you want the list of files for
     #
-    # @return [String] HTML containing all the ref links
-    def commit_refs(commit, repo_param)
-      commit.refs.map{ |r| commit_ref(r, repo_param) }.join("\n")
+    # @return [String] a +<ul>+ with lots of +<li>+ children.
+    def file_listing(diff)
+      list = []
+      diff.deltas.each_with_index do |delta, index|
+        if delta.deleted?
+          list << "<li class='deleted'><span class='icon-remove' title='deleted'></span> <a href='#file-#{index + 1}'>#{delta.new_file[:path]}</a></li>"
+        elsif delta.added?
+          list << "<li class='added'><span class='icon-ok' title='added'></span> <a href='#file-#{index + 1}'>#{delta.new_file[:path]}</a></li>"
+        elsif delta.modified?
+          list << "<li class='changed'><span class='icon-edit' title='modified'></span> <a href='#file-#{index + 1}'>#{delta.new_file[:path]}</a></li>"
+        end
+      end
+      "<ul class='unstyled'>#{list.join}</ul>"
     end
 
-    # returns a string including the link to download a certain 
-    # tree of the repo
+    # Highlights commit diff
     #
-    # @param [Grit::Tree] tree the tree you want an archive link for
-    # @param [String] repo_param the url-sanitised-name of the repo
-    #   (for the link path)
+    # @param [Rugged::Hunk] diff hunk for highlighting
     #
-    # @return [String] the HTML link to the archive.
-    def archive_link(tree, repo_param)
-      "<a class=\"download\" href=\"" + prefix_url("#{repo_param}/archive/#{tree.id}.tar.gz") + "\" title=\"Download a tar.gz snapshot of this Tree\">Download Archive</a>"
-    end
+    # @return [String] highlighted HTML.code
+    def highlight_diff(hunk)
+      lines = []
+      lines << hunk.header
 
-    # returns a string including the link to download a patch for a certain
-    # commit to the repo
-    #
-    # @param [Grit::Commit] commit the commit you want a patch for
-    # @param [String] repo_param the url-sanitised name for the repo
-    #   (for the link path)
-    #
-    # @return [String] the HTML link to the patch
-    def patch_link(commit, repo_param)
-      "<a class=\"download\" href=\"" + prefix_url("#{repo_param}/commit/#{commit.id}.patch") + "\" title=\"Download a patch file of this Commit\">Download Patch</a>"
+      hunk.each_line do |line|
+        if line.context?
+          lines << "  #{line.content}"
+        elsif line.deletion?
+          lines << "- #{line.content}"
+        elsif line.addition?
+          lines << "+ #{line.content}"
+        end
+      end
+
+      formatter = Rouge::Formatters::HTML.new
+      lexer     = Rouge::Lexers::Diff.new
+
+      source   = lines.join
+      encoding = source.encoding
+      source   = source.force_encoding(Encoding::UTF_8)
+
+      hd = formatter.format lexer.lex(source)
+      hd.force_encoding encoding
     end
 
-    # returns a HTML (+<ul>+) list of the files altered in a given commit.
-    #
-    # It includes classes for added/altered/deleted and also anchor links 
-    # to the diffs for further down the page.
+    # Highlights blob source
     #
-    # @param [Grit::Commit] commit the commit you want the list of files for
+    # @param [Rugged::Blob] blob to highlight source
     #
-    # @return [String] a +<ul>+ with lots of +<li>+ children.
-    def file_listing(commit)
-      # The only reason this doesn't work 100% of the time is because grit doesn't :/
-      # if i find a fix, it'll go upstream :D
-      count = 0
-      out = commit.diffs.map do |diff|
-        count = count + 1
-        if diff.deleted_file
-          %(<li class='file_rm'><a href='#file_#{count}'>#{diff.a_path}</a></li>)
-        else
-          cla = diff.new_file ? "add" : "diff"
-          %(<li class='file_#{cla}'><a href='#file_#{count}'>#{diff.a_path}</a></li>)
-        end
+    # @return [String] highlighted HTML.code
+    def highlight_source(source, filename='')
+      source    = source.force_encoding(Encoding::UTF_8)
+      formatter = Rouge::Formatters::HTML.new(line_numbers: true, wrap: false)
+      lexer     = Rouge::Lexer.guess_by_filename(filename)
+
+      if lexer == Rouge::Lexers::PlainText
+        lexer = Rouge::Lexer.guess_by_source(source) || Rouge::Lexers::PlainText
       end
-      "<ul id='files'>#{out.join}</ul>"
+
+      formatter.format lexer.lex(source)
     end
 
     # Formats the text to remove multiple spaces and newlines, and then inserts
     # HTML linebreaks.
     #
-    # Stolen from rails: ActionView::Helpers::TextHelper#simple_format
-    # and simplified to just use <p> tags without any options, then modified 
+    # Borrowed from Rails: ActionView::Helpers::TextHelper#simple_format
+    # and simplified to just use <p> tags without any options, then modified
     # more later.
     #
     # @param [String] text the text you want formatted
-    # 
+    #
     # @return [String] the formatted text
     def simple_format(text)
       text.gsub!(/ +/, " ")
@@ -151,47 +212,16 @@ module Ginatra
       text
     end
 
-    # Cleans up the particularly volatile parts of HTML 
-    # and replaces them with their entities. Replaces the following 
-    # characters:
-    #  - &
-    #  - >
-    #  - <
-    #  - '
-    #
-    # If you are using this with #simple_format, do not forget to call
-    # this one first, then put in unsanitised linebreaks. The other way around
-    # is full of fail.
-    #
-    # stolen from rails: ERB::Util
-    #
-    # @see Ginatra::Helpers#simple_format
-    #
-    # @param [#to_s] clean_me the object to clean.
-    #
-    # @return [String] the cleaned html text.
-    def html_escape(clean_me)
-      clean_me.to_s.gsub(/[&"<>]/) do |special|
-        { '&' => '&amp;',
-          '>' => '&gt;',
-          '<' => '&lt;',
-          '"' => '&quot;' }[special]
-      end
-    end
-    alias :h :html_escape
-
     # Truncates a given text to a certain number of letters, including a special ending if needed.
     #
-    # Stolen and bastardised from rails
-    # 
     # @param [String] text the text to truncate
     # @option options [Integer] :length   (30) the length you want the output string
     # @option options [String]  :omission ("...") the string to show an omission.
     #
     # @return [String] the truncated text.
     def truncate(text, options={})
-        options[:length] ||= 30
-        options[:omission] ||= "..."
+      options[:length] ||= 30
+      options[:omission] ||= "..."
 
       if text
         l = options[:length] - options[:omission].length
@@ -203,32 +233,17 @@ module Ginatra
 
     # Returns the rfc representation of a date, for use in the atom feeds.
     #
-    # stolen from Marley
-    #
     # @param [DateTime] datetime the date to format
     # @return [String] the formatted datetime
     def rfc_date(datetime)
       datetime.strftime("%Y-%m-%dT%H:%M:%SZ") # 2003-12-13T18:30:02Z
     end
 
-    # Returns the Hostname of the given install. 
-    # used in the atom feeds.
+    # Returns the Hostname of the given install, for use in the atom feeds.
     #
-    # stolen from Marley
-    # 
     # @return [String] the hostname of the server. Respects HTTP-X-Forwarded-For
     def hostname
       (request.env['HTTP_X_FORWARDED_SERVER'] =~ /[a-z]*/) ? request.env['HTTP_X_FORWARDED_SERVER'] : request.env['HTTP_HOST']
     end
-
-    # Spits out a HTML link to the atom feed for a given ref of a given repo
-    #
-    # @param [Sting] repo_param the url-sanitised-name of a given repo
-    # @param [String] ref the ref to link to.
-    #
-    # @return [String] the HTML containing the link to the feed.
-    def atom_feed_link(repo_param, ref=nil)
-      "<a href=\"" + prefix_url("#{repo_param}#{"/#{ref}" if !ref.nil?}.atom") + "\" title=\"Atom Feed\" class=\"atom\">Feed</a>"
-    end
   end
 end