jro_apps/redmine Commit - r3246:39c585740d45

Refactor: Extract method to create a Change from a Changeset....

Eric Davis -

r3246:39c585740d45

parent child

Context file:

r3246:39c585740d45

Collapse all files

app/models/changeset.rb +9 0

             # Redmine - project management software
             # Copyright (C) 2006-2008  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'iconv'
             class Changeset < ActiveRecord::Base
               belongs_to :repository
               belongs_to :user
               has_many :changes, :dependent => :delete_all
               has_and_belongs_to_many :issues
               acts_as_event :title => Proc.new {|o| "#{l(:label_revision)} #{o.revision}" + (o.short_comments.blank? ? '' : (': ' + o.short_comments))},
                             :description => :long_comments,
                             :datetime => :committed_on,
                             :url => Proc.new {|o| {:controller => 'repositories', :action => 'revision', :id => o.repository.project, :rev => o.revision}}
               acts_as_searchable :columns => 'comments',
                                  :include => {:repository => :project},
                                  :project_key => "#{Repository.table_name}.project_id",
                                  :date_column => 'committed_on'
               acts_as_activity_provider :timestamp => "#{table_name}.committed_on",
                                         :author_key => :user_id,
                                         :find_options => {:include => [:user, {:repository => :project}]}
               validates_presence_of :repository_id, :revision, :committed_on, :commit_date
               validates_uniqueness_of :revision, :scope => :repository_id
               validates_uniqueness_of :scmid, :scope => :repository_id, :allow_nil => true
               named_scope :visible, lambda {|*args| { :include => {:repository => :project},
                                                       :conditions => Project.allowed_to_condition(args.first || User.current, :view_changesets) } }
               def revision=(r)
                 write_attribute :revision, (r.nil? ? nil : r.to_s)
               end
               def comments=(comment)
                 write_attribute(:comments, Changeset.normalize_comments(comment))
               end
               def committed_on=(date)
                 self.commit_date = date
                 super
               end
               def project
                 repository.project
               end
               def author
                 user || committer.to_s.split('<').first
               end
               def before_create
                 self.user = repository.find_committer_user(committer)
               end
               def after_create
                 scan_comment_for_issue_ids
               end
               require 'pp'
               def scan_comment_for_issue_ids
                 return if comments.blank?
                 # keywords used to reference issues
                 ref_keywords = Setting.commit_ref_keywords.downcase.split(",").collect(&:strip)
                 # keywords used to fix issues
                 fix_keywords = Setting.commit_fix_keywords.downcase.split(",").collect(&:strip)
                 # status and optional done ratio applied
                 fix_status = IssueStatus.find_by_id(Setting.commit_fix_status_id)
                 done_ratio = Setting.commit_fix_done_ratio.blank? ? nil : Setting.commit_fix_done_ratio.to_i
                 kw_regexp = (ref_keywords + fix_keywords).collect{|kw| Regexp.escape(kw)}.join("|")
                 return if kw_regexp.blank?
                 referenced_issues = []
                 if ref_keywords.delete('*')
                   # find any issue ID in the comments
                   target_issue_ids = []
                   comments.scan(%r{([\s\(\[,-]|^)#(\d+)(?=[[:punct:]]|\s|<|$)}).each { |m| target_issue_ids << m[1] }
                   referenced_issues += find_referenced_issues_by_id(target_issue_ids)
                 end
                 comments.scan(Regexp.new("(#{kw_regexp})[\s:]+(([\s,;&]*#?\\d+)+)", Regexp::IGNORECASE)).each do |match|
                   action = match[0]
                   target_issue_ids = match[1].scan(/\d+/)
                   target_issues = find_referenced_issues_by_id(target_issue_ids)
                   if fix_status && fix_keywords.include?(action.downcase)
                     # update status of issues
                     logger.debug "Issues fixed by changeset #{self.revision}: #{issue_ids.join(', ')}." if logger && logger.debug?
                     target_issues.each do |issue|
                       # the issue may have been updated by the closure of another one (eg. duplicate)
                       issue.reload
                       # don't change the status is the issue is closed
                       next if issue.status.is_closed?
                       csettext = "r#{self.revision}"
                       if self.scmid && (! (csettext =~ /^r[0-9]+$/))
                         csettext = "commit:\"#{self.scmid}\""
                       end
                       journal = issue.init_journal(user || User.anonymous, ll(Setting.default_language, :text_status_changed_by_changeset, csettext))
                       issue.status = fix_status
                       issue.done_ratio = done_ratio if done_ratio
                       Redmine::Hook.call_hook(:model_changeset_scan_commit_for_issue_ids_pre_issue_update,
                                               { :changeset => self, :issue => issue })
                       issue.save
                     end
                   end
                   referenced_issues += target_issues
                 end
                 self.issues = referenced_issues.uniq
               end
               def short_comments
                 @short_comments || split_comments.first
               end
               def long_comments
                 @long_comments || split_comments.last
               end
               # Returns the previous changeset
               def previous
                 @previous ||= Changeset.find(:first, :conditions => ['id < ? AND repository_id = ?', self.id, self.repository_id], :order => 'id DESC')
               end
               # Returns the next changeset
               def next
                 @next ||= Changeset.find(:first, :conditions => ['id > ? AND repository_id = ?', self.id, self.repository_id], :order => 'id ASC')
               end
               # Strips and reencodes a commit log before insertion into the database
               def self.normalize_comments(str)
                 to_utf8(str.to_s.strip)
               end
+              # Creates a new Change from it's common parameters
+              def create_change(change)
+                Change.create(:changeset => self,
+                              :action => change[:action],
+                              :path => change[:path],
+                              :from_path => change[:from_path],
+                              :from_revision => change[:from_revision])
+              end
               private
               # Finds issues that can be referenced by the commit message
               # i.e. issues that belong to the repository project, a subproject or a parent project
               def find_referenced_issues_by_id(ids)
                 Issue.find_all_by_id(ids, :include => :project).select {|issue|
                   project == issue.project || project.is_ancestor_of?(issue.project) || project.is_descendant_of?(issue.project)
                 }
               end
               def split_comments
                 comments =~ /\A(.+?)\r?\n(.*)$/m
                 @short_comments = $1 || comments
                 @long_comments = $2.to_s.strip
                 return @short_comments, @long_comments
               end
               def self.to_utf8(str)
                 return str if /\A[\r\n\t\x20-\x7e]*\Z/n.match(str) # for us-ascii
                 encoding = Setting.commit_logs_encoding.to_s.strip
                 unless encoding.blank? || encoding == 'UTF-8'
                   begin
                     return Iconv.conv('UTF-8', encoding, str)
                   rescue Iconv::Failure
                     # do nothing here
                   end
                 end
                 str
               end
             end

app/models/repository/darcs.rb +1 -5

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'redmine/scm/adapters/darcs_adapter'
             class Repository::Darcs < Repository
               validates_presence_of :url
               def scm_adapter
                 Redmine::Scm::Adapters::DarcsAdapter
               end
               def self.scm_name
                 'Darcs'
               end
               def entry(path=nil, identifier=nil)
                 patch = identifier.nil? ? nil : changesets.find_by_revision(identifier)
                 scm.entry(path, patch.nil? ? nil : patch.scmid)
               end
               def entries(path=nil, identifier=nil)
                 patch = identifier.nil? ? nil : changesets.find_by_revision(identifier)
                 entries = scm.entries(path, patch.nil? ? nil : patch.scmid)
                 if entries
                   entries.each do |entry|
                     # Search the DB for the entry's last change
                     changeset = changesets.find_by_scmid(entry.lastrev.scmid) if entry.lastrev && !entry.lastrev.scmid.blank?
                     if changeset
                       entry.lastrev.identifier = changeset.revision
                       entry.lastrev.name = changeset.revision
                       entry.lastrev.time = changeset.committed_on
                       entry.lastrev.author = changeset.committer
                     end
                   end
                 end
                 entries
               end
               def cat(path, identifier=nil)
                 patch = identifier.nil? ? nil : changesets.find_by_revision(identifier.to_s)
                 scm.cat(path, patch.nil? ? nil : patch.scmid)
               end
               def diff(path, rev, rev_to)
                 patch_from = changesets.find_by_revision(rev)
                 return nil if patch_from.nil?
                 patch_to = changesets.find_by_revision(rev_to) if rev_to
                 if path.blank?
                   path = patch_from.changes.collect{|change| change.path}.join(' ')
                 end
                 patch_from ? scm.diff(path, patch_from.scmid, patch_to ? patch_to.scmid : nil) : nil
               end
               def fetch_changesets
                 scm_info = scm.info
                 if scm_info
                   db_last_id = latest_changeset ? latest_changeset.scmid : nil
                   next_rev = latest_changeset ? latest_changeset.revision.to_i + 1 : 1
                   # latest revision in the repository
                   scm_revision = scm_info.lastrev.scmid
                   unless changesets.find_by_scmid(scm_revision)
                     revisions = scm.revisions('', db_last_id, nil, :with_path => true)
                     transaction do
                       revisions.reverse_each do |revision|
                         changeset = Changeset.create(:repository => self,
                                                      :revision => next_rev,
                                                      :scmid => revision.scmid,
                                                      :committer => revision.author,
                                                      :committed_on => revision.time,
                                                      :comments => revision.message)
                         revision.paths.each do |change|
-                          Change.create(:changeset => changeset,
+                          changeset.create_change(change)
-                                        :action => change[:action],
-                                        :path => change[:path],
-                                        :from_path => change[:from_path],
-                                        :from_revision => change[:from_revision])
                         end
                         next_rev += 1
                       end if revisions
                     end
                   end
                 end
               end
             end

app/models/repository/mercurial.rb +1 -5

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'redmine/scm/adapters/mercurial_adapter'
             class Repository::Mercurial < Repository
               attr_protected :root_url
               validates_presence_of :url
               def scm_adapter
                 Redmine::Scm::Adapters::MercurialAdapter
               end
               def self.scm_name
                 'Mercurial'
               end
               def entries(path=nil, identifier=nil)
                 entries=scm.entries(path, identifier)
                 if entries
                   entries.each do |entry|
                     next unless entry.is_file?
                     # Set the filesize unless browsing a specific revision
                     if identifier.nil?
                       full_path = File.join(root_url, entry.path)
                       entry.size = File.stat(full_path).size if File.file?(full_path)
                     end
                     # Search the DB for the entry's last change
                     change = changes.find(:first, :conditions => ["path = ?", scm.with_leading_slash(entry.path)], :order => "#{Changeset.table_name}.committed_on DESC")
                     if change
                       entry.lastrev.identifier = change.changeset.revision
                       entry.lastrev.name = change.changeset.revision
                       entry.lastrev.author = change.changeset.committer
                       entry.lastrev.revision = change.revision
                     end
                   end
                 end
                 entries
               end
               def fetch_changesets
                 scm_info = scm.info
                 if scm_info
                   # latest revision found in database
                   db_revision = latest_changeset ? latest_changeset.revision.to_i : -1
                   # latest revision in the repository
                   latest_revision = scm_info.lastrev
                   return if latest_revision.nil?
                   scm_revision = latest_revision.identifier.to_i
                   if db_revision < scm_revision
                     logger.debug "Fetching changesets for repository #{url}" if logger && logger.debug?
                     identifier_from = db_revision + 1
                     while (identifier_from <= scm_revision)
                       # loads changesets by batches of 100
                       identifier_to = [identifier_from + 99, scm_revision].min
                       revisions = scm.revisions('', identifier_from, identifier_to, :with_paths => true)
                       transaction do
                         revisions.each do |revision|
                           changeset = Changeset.create(:repository => self,
                                                        :revision => revision.identifier,
                                                        :scmid => revision.scmid,
                                                        :committer => revision.author,
                                                        :committed_on => revision.time,
                                                        :comments => revision.message)
                           revision.paths.each do |change|
-                            Change.create(:changeset => changeset,
+                            changeset.create_change(change)
-                                          :action => change[:action],
-                                          :path => change[:path],
-                                          :from_path => change[:from_path],
-                                          :from_revision => change[:from_revision])
                           end
                         end
                       end unless revisions.nil?
                       identifier_from = identifier_to + 1
                     end
                   end
                 end
               end
             end

app/models/repository/subversion.rb +1 -5

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'redmine/scm/adapters/subversion_adapter'
             class Repository::Subversion < Repository
               attr_protected :root_url
               validates_presence_of :url
               validates_format_of :url, :with => /^(http|https|svn(\+[^\s:\/\\]+)?|file):\/\/.+/i
               def scm_adapter
                 Redmine::Scm::Adapters::SubversionAdapter
               end
               def self.scm_name
                 'Subversion'
               end
               def latest_changesets(path, rev, limit=10)
                 revisions = scm.revisions(path, rev, nil, :limit => limit)
                 revisions ? changesets.find_all_by_revision(revisions.collect(&:identifier), :order => "committed_on DESC", :include => :user) : []
               end
               # Returns a path relative to the url of the repository
               def relative_path(path)
                 path.gsub(Regexp.new("^\/?#{Regexp.escape(relative_url)}"), '')
               end
               def fetch_changesets
                 scm_info = scm.info
                 if scm_info
                   # latest revision found in database
                   db_revision = latest_changeset ? latest_changeset.revision.to_i : 0
                   # latest revision in the repository
                   scm_revision = scm_info.lastrev.identifier.to_i
                   if db_revision < scm_revision
                     logger.debug "Fetching changesets for repository #{url}" if logger && logger.debug?
                     identifier_from = db_revision + 1
                     while (identifier_from <= scm_revision)
                       # loads changesets by batches of 200
                       identifier_to = [identifier_from + 199, scm_revision].min
                       revisions = scm.revisions('', identifier_to, identifier_from, :with_paths => true)
                       revisions.reverse_each do |revision|
                         transaction do
                           changeset = Changeset.create(:repository => self,
                                                        :revision => revision.identifier,
                                                        :committer => revision.author,
                                                        :committed_on => revision.time,
                                                        :comments => revision.message)
                           revision.paths.each do |change|
-                            Change.create(:changeset => changeset,
+                            changeset.create_change(change)
-                                          :action => change[:action],
-                                          :path => change[:path],
-                                          :from_path => change[:from_path],
-                                          :from_revision => change[:from_revision])
                           end unless changeset.new_record?
                         end
                       end unless revisions.nil?
                       identifier_from = identifier_to + 1
                     end
                   end
                 end
               end
               private
               # Returns the relative url of the repository
               # Eg: root_url = file:///var/svn/foo
               #     url      = file:///var/svn/foo/bar
               #     => returns /bar
               def relative_url
                 @relative_url ||= url.gsub(Regexp.new("^#{Regexp.escape(root_url || scm.root_url)}", Regexp::IGNORECASE), '')
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages