gollum_rails 1.4.0.rc2 → 1.4.0.rc3

data/lib/gollum_rails/adapters/gollum/page.rb

@@ -1,177 +1,177 @@
-module GollumRails
-  module Adapters
-    module Gollum
-
-      # Main page class for the Gollum connector.
-      #
-      # It provides some awesome features for connecting gollum to gollum_rails such as:
-      #   * new_page
-      #   * find_page
-      #   * delete_page
-      #   * rename_page
-      #   * move_page
-      #   * first_page_commit
-      #   * page_creation time
-      #   * ...
-      #
-      class Page
-
-        Connector.page_class = self
-
-        # Gets / Sets current page
-        attr_accessor :page
-
-          # Gets / Sets the wiki
-        attr_accessor :wiki
-
-        # Initializer
-        def initialize
-          @wiki = Connector.wiki_class
-        end
-
-
-        # creates a new Page
-        #
-        # name - String
-        # type - Symbol
-        # content - Text
-        # commit - Hash or instance of Committer
-        #
-        # Returns the commit id
-        def new_page( name, content,type=:markdown, commit={} )
-          @wiki.write_page name.to_s, type, content, commit if name
-          @page = @wiki.page name
-          @page
-        end
-
-        # updates an existing page
-        #
-        # new - Hash with changed data
-        # commit - Hash or instance of Committer
-        # old - also an instance of self
-        #
-        # Returns the commit id
-        def update_page( new, commit={}, old=nil)
-          if new.is_a?(Hash)
-            commit_id = @wiki.update_page (old||@page), 
-                                          new[:name]||@page.name, 
-                                          new[:format]||@page.format, 
-                                          new[:content]||@page.raw_data, 
-                                          commit 
-          else
-            raise Error.new  "commit must be a Hash. #{new.class} given", :crit
-          end
-
-          # this is very ugly. Shouldn't gollum return the new page?
-          @page = @page.find(new[:name]||@page.name, commit_id)
-          @page
-        end
-
-        # deletes an existing page
-        #
-        # page - instance of self
-        # commit - Hash or instance of Committer
-        #
-        # Returns the commit id
-        def delete_page( commit={}, page = nil )
-          @wiki.delete_page (page||@page), commit
-        end
-        
-        # renames an existing page
-        #
-        # page - instance of myself
-        # newname - new pagename
-        # commit - Hash or instance of Committer
-        #
-        # Returns the commit id
-        def rename_page( page, newname, commit={} )
-
-        end
-
-        # finds all versions of a page
-        #
-        # name - the pagename to search
-        #
-        # Returns the Gollum::Page class
-        def find_page(name)
-          @wiki.page ::Gollum::Page.cname(name)
-        end
-        
-        # moves an existing page
-        #
-        # TODO:
-        #   * implement
-        def move_page()
-        end
-
-        # gets page last edit date
-        #
-        # Returns an instance of Time
-        def page_last_edited_date
-          if @page
-            return @page.versions.first.authored_date
-          else
-            raise Error.new  "page cannot be empty for #{__method__}", :high
-          end
-        end
-
-        # gets the latest commit
-        #
-        # Returns an instance of Grit::Commit
-        def page_last_commit
-          if @page
-            return @page.versions.first
-          else
-            raise Error.new "page cannot be empty for #{__method__}", :high
-          end
-        end
-
-        # gets the creation date of the page
-        #
-        # Returns an instance of Time
-        def page_created
-          if @page
-            return @page.versions.last.authored_date
-          else
-            raise Error.new  "page cannot be empty for #{__method__}", :high
-          end
-
-        end
-        
-        # gets the first page commit
-        #
-        # Returns an instance of Grit::Commit
-        def page_first_commit
-          if @page
-            return @page.versions.last
-          else
-            raise Error.new  "page cannot be empty for #{__method__}", :high
-          end
-        end
-
-        # gets a specific commit version
-        #
-        # Returns an instance of Grit::Commit
-        def page_commit(id)
-          if @page
-            return @page.versions.each{|v| return v if v.id == id}
-          else
-            raise Error.new  "page cannot be empty for #{__method__}", :high
-          end
-        end
-
-        # gets a specific commit time
-        #
-        # Returns an instance of Time
-        def page_commit_date(id)
-          if @page
-            return @page.versions.each{|v| return v.authored_date if v.id == id}
-          else
-            raise Error.new  "page cannot be empty for #{__method__}", :high
-          end
-        end
-
-      end
-    end
-  end
-end
+module GollumRails
+  module Adapters
+    module Gollum
+
+      # Main page class for the Gollum connector.
+      #
+      # It provides some awesome features for connecting gollum to gollum_rails such as:
+      #   * new_page
+      #   * find_page
+      #   * delete_page
+      #   * rename_page
+      #   * move_page
+      #   * first_page_commit
+      #   * page_creation time
+      #   * ...
+      #
+      class Page
+
+        Connector.page_class = self
+
+        # Gets / Sets current page
+        attr_accessor :page
+
+          # Gets / Sets the wiki
+        attr_accessor :wiki
+
+        # Initializer
+        def initialize
+          @wiki = Connector.wiki_class
+        end
+
+
+        # creates a new Page
+        #
+        # name - String
+        # type - Symbol
+        # content - Text
+        # commit - Hash or instance of Committer
+        #
+        # Returns the commit id
+        def new_page( name, content,type=:markdown, commit={} )
+          @wiki.write_page name.to_s, type, content, commit if name
+          @page = @wiki.page name
+          @page
+        end
+
+        # updates an existing page
+        #
+        # new - Hash with changed data
+        # commit - Hash or instance of Committer
+        # old - also an instance of self
+        #
+        # Returns the commit id
+        def update_page( new, commit={}, old=nil)
+          if new.is_a?(Hash)
+            commit_id = @wiki.update_page (old||@page), 
+                                          new[:name]||@page.name, 
+                                          new[:format]||@page.format, 
+                                          new[:content]||@page.raw_data, 
+                                          commit 
+          else
+            raise Error.new  "commit must be a Hash. #{new.class} given", :crit
+          end
+
+          # this is very ugly. Shouldn't gollum return the new page?
+          @page = @page.find(new[:name]||@page.name, commit_id)
+          @page
+        end
+
+        # deletes an existing page
+        #
+        # page - instance of self
+        # commit - Hash or instance of Committer
+        #
+        # Returns the commit id
+        def delete_page( commit={}, page = nil )
+          @wiki.delete_page (page||@page), commit
+        end
+        
+        # renames an existing page
+        #
+        # page - instance of myself
+        # newname - new pagename
+        # commit - Hash or instance of Committer
+        #
+        # Returns the commit id
+        def rename_page( page, newname, commit={} )
+
+        end
+
+        # finds all versions of a page
+        #
+        # name - the pagename to search
+        #
+        # Returns the Gollum::Page class
+        def find_page(name)
+          @wiki.page ::Gollum::Page.cname(name)
+        end
+        
+        # moves an existing page
+        #
+        # TODO:
+        #   * implement
+        def move_page()
+        end
+
+        # gets page last edit date
+        #
+        # Returns an instance of Time
+        def page_last_edited_date
+          if @page
+            return @page.versions.first.authored_date
+          else
+            raise Error.new  "page cannot be empty for #{__method__}", :high
+          end
+        end
+
+        # gets the latest commit
+        #
+        # Returns an instance of Grit::Commit
+        def page_last_commit
+          if @page
+            return @page.versions.first
+          else
+            raise Error.new "page cannot be empty for #{__method__}", :high
+          end
+        end
+
+        # gets the creation date of the page
+        #
+        # Returns an instance of Time
+        def page_created
+          if @page
+            return @page.versions.last.authored_date
+          else
+            raise Error.new  "page cannot be empty for #{__method__}", :high
+          end
+
+        end
+        
+        # gets the first page commit
+        #
+        # Returns an instance of Grit::Commit
+        def page_first_commit
+          if @page
+            return @page.versions.last
+          else
+            raise Error.new  "page cannot be empty for #{__method__}", :high
+          end
+        end
+
+        # gets a specific commit version
+        #
+        # Returns an instance of Grit::Commit
+        def page_commit(id)
+          if @page
+            return @page.versions.each{|v| return v if v.id == id}
+          else
+            raise Error.new  "page cannot be empty for #{__method__}", :high
+          end
+        end
+
+        # gets a specific commit time
+        #
+        # Returns an instance of Time
+        def page_commit_date(id)
+          if @page
+            return @page.versions.each{|v| return v.authored_date if v.id == id}
+          else
+            raise Error.new  "page cannot be empty for #{__method__}", :high
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/gollum_rails/adapters/gollum/wiki.rb

@@ -1,42 +1,42 @@
-require 'grit'
-module GollumRails
-  module Adapters
-    module Gollum
-
-      # TODO: doc
-      class  Wiki
-
-        # Gets / Sets the git path or object
-        attr_accessor :git
-
-        # Initializes the class
-        #
-        # location - String or Grit::Repo
-        def initialize(location)
-          @git = location
-          if location.is_a? ::String
-            con = ::Gollum::Wiki.new @git
-          else
-            con= ::Gollum::Wiki.new @git.path
-          end
-          Connector.wiki_class = con
-        end
-      
-        # Static call from within any other class
-        #
-        # Returns a new instance of this class
-        def self.wiki(location)
-          Wiki.new(location)
-        end
-
-        # Forwards unknown methods to Gollum::Wiki
-        #
-        # may throw an Argument error or method missing
-        def self.method_missing(name, *args)
-          Connector.wiki_class.send(name, *args)
-        end
-
-      end
-    end
-  end
-end
+require 'grit'
+module GollumRails
+  module Adapters
+    module Gollum
+
+      # TODO: doc
+      class  Wiki
+
+        # Gets / Sets the git path or object
+        attr_accessor :git
+
+        # Initializes the class
+        #
+        # location - String or Grit::Repo
+        def initialize(location)
+          @git = location
+          if location.is_a? ::String
+            con = ::Gollum::Wiki.new @git
+          else
+            con= ::Gollum::Wiki.new @git.path
+          end
+          Connector.wiki_class = con
+        end
+      
+        # Static call from within any other class
+        #
+        # Returns a new instance of this class
+        def self.wiki(location)
+          Wiki.new(location)
+        end
+
+        # Forwards unknown methods to Gollum::Wiki
+        #
+        # may throw an Argument error or method missing
+        def self.method_missing(name, *args)
+          Connector.wiki_class.send(name, *args)
+        end
+
+      end
+    end
+  end
+end

data/lib/gollum_rails/page.rb

@@ -1,266 +1,266 @@
-require 'thread'
-
-module GollumRails
-
-  # Main class, used to interact with rails.
-  #
-  # Methods, which are available:
-  #   * find
-  #   * update_attributes
-  #   * find_by_*
-  #   * create
-  #   * new
-  #   * save
-  #   * delete
-  #   * find_or_initialize_by_naname
-  #
-  class Page
-    extend ::ActiveModel::Callbacks
-    include ::ActiveModel::Validations
-    include ::ActiveModel::Conversion
-    extend ::ActiveModel::Naming
-
-
-    # Callback for save
-    define_model_callbacks :save
-
-    # Callback for update
-    define_model_callbacks :update
-
-    # Callback for delete
-    define_model_callbacks :delete
-
-    # static
-    class << self
-      # Gets / Sets the gollum page
-      #
-      attr_accessor :gollum_page
-
-      # Sets the validator
-      attr_writer :validator
-
-      # Finds an existing page or creates it
-      #
-      # name - The name
-      # commit - Hash
-      #
-      # Returns self
-      def find_or_initialize_by_name(name, commit)
-        result_for_find = self.find(name)
-        self.create({:format => :markdown, :name => name, :content => ".", :commit => commit })
-      end
-
-      # Checks if the fileformat is supported
-      #
-      # format - String
-      #
-      # Returns true or false
-      def format_supported?(format)
-        supported = ['ascii', 'github-markdown','markdown', 'creole', 'org', 'pod', 'rdoc']
-        format.in?(supported)
-      end
-
-      # first creates an instance of itself and executes the save function.
-      #
-      # hash - Hash containing the page data
-      #
-      #
-      # Returns an instance of Gollum::Page or false
-      def create(hash)
-        page = Page.new hash
-        page.save
-      end
-
-
-      # calls `create` on current class. If returned value is nil an exception will be thrown
-      #
-      # hash - Hash containing the page data
-      #
-      #
-      # Returns an instance of Gollum::Page
-      def create!(hash)
-        action = self.create(hash)
-        action
-      end
-
-      # Finds a page based on the name and specified version
-      #
-      # name - the name of the page
-      #
-      # Return an instance of Gollum::Page
-      def find(name)
-        page = GollumRails::Adapters::Gollum::Page.new
-        page.find_page name
-      end
-
-      # Gets all pages in the wiki
-      def all
-        self.wiki.pages
-      end
-      alias_method :find_all, :all
-
-      # Gets the wiki instance
-      def wiki
-        @wiki || Adapters::Gollum::Connector.wiki_class
-      end
-
-    end
-
-
-    # Initializes a new Page
-    #
-    # attrs - Hash of attributes
-    #
-    # commit must be given to perform any page action!
-    def initialize(attrs = {})
-      if Adapters::Gollum::Connector.enabled
-        attrs.each{|k,v| self.public_send("#{k}=",v)} if attrs
-      else
-        raise GollumInternalError, 'gollum_rails is not enabled!'
-      end
-    end
-
-    #########
-    # Setters
-    #########
-
-
-    # Gets / Sets the pages name
-    attr_accessor :name
-
-    # Gets / Sets the contents content
-    attr_accessor :content
-
-    # Gets / Sets the commit Hash
-    attr_accessor :commit
-
-    # Sets the format
-    attr_writer :format
-
-
-    #########
-    # Getters
-    #########
-
-
-    # Gets the pages format
-    def format
-      @format.to_sym
-    end
-
-
-    # Gets the page class
-    def page
-      @page ||= Adapters::Gollum::Connector.page_class.new
-    end
-
-    #############
-    # activemodel
-    #############
-
-    # Handles the connection betweet plain activemodel and Gollum
-    # Saves current page in GIT wiki
-    # If another page with the same name is existing, gollum_rails
-    # will detect it and returns that page instead.
-    #
-    # Examples:
-    #
-    #   obj = GollumRails::Page.new <params>
-    #   @article = obj.save
-    #   # => Gollum::Page
-    #
-    #   @article.name
-    #   whatever name you have entered OR the name of the previous
-    #   created page
-    #
-    #
-    # TODO:
-    #   * overriding for creation(duplicates)
-    #   * do not alias save! on save
-    #
-    # Returns an instance of Gollum::Page or false
-    def save
-      run_callbacks :save do
-        return false unless valid?
-        begin
-          page.new_page(name,content,format,commit)
-        rescue ::Gollum::DuplicatePageError => e
-          page.page = page.find_page(name)
-        end
-        return page.page
-      end
-    end
-
-    # aliasing save
-    #
-    # TODO:
-    #   * implement full method!
-    alias_method :save!, :save
-
-    # Updates an existing page (or created)
-    #
-    # hash - Hash containing the attributes, you want to update
-    # commit - optional. If given this commit will be used instead of that one, used
-    #          to initialize the instance
-    #
-    #
-    # Returns an instance of Gollum::Page
-    def update_attributes(hash, commit=nil)
-      run_callbacks :update do
-        page.update_page hash, get_right_commit(commit)
-      end
-    end
-
-    # Deletes current page (also available static. See below)
-    #
-    # commit - optional. If given this commit will be used instead of that one, used
-    #          to initialize the instance
-    #
-    # Returns the commit id of the current action as String
-    def delete(commit=nil)
-      run_callbacks :delete do
-        page.delete_page get_right_commit(commit)
-      end
-    end
-
-    # checks if entry already has been saved
-    #
-    #
-    def persisted?
-      return true if page.page.instance_of?(::Gollum::Page)
-      return false
-    end
-    # Previews the page - Mostly used if you want to see what you do before saving
-    #
-    # This is an extremely performant method!
-    # 1 rendering attempt take depending on the content about 0.001 (simple markdown)
-    # upto 0.004 (1000 chars markdown) seconds, which is quite good
-    #
-    #
-    # format - Specify the format you want to render with see {self.format_supported?}
-    #          for formats
-    #
-    # Returns a String
-    def preview(format=:markdown)
-      preview = self.class.wiki.preview_page @name, @content, format
-      preview.formatted_data
-    end
-
-
-    #######
-    private
-    #######
-
-    # Get the right commit out of 2 commits
-    #
-    # commit_local - local commit Hash
-    #
-    # Returns local_commit > class_commit
-    def get_right_commit(commit_local)
-      com = commit if commit_local.nil?
-      com = commit_local if !commit_local.nil?
-      return com
-    end
-
-  end
- end
+require 'thread'
+
+module GollumRails
+
+  # Main class, used to interact with rails.
+  #
+  # Methods, which are available:
+  #   * find
+  #   * update_attributes
+  #   * find_by_*
+  #   * create
+  #   * new
+  #   * save
+  #   * delete
+  #   * find_or_initialize_by_naname
+  #
+  class Page
+    extend ::ActiveModel::Callbacks
+    include ::ActiveModel::Validations
+    include ::ActiveModel::Conversion
+    extend ::ActiveModel::Naming
+
+
+    # Callback for save
+    define_model_callbacks :save
+
+    # Callback for update
+    define_model_callbacks :update
+
+    # Callback for delete
+    define_model_callbacks :delete
+
+    # static
+    class << self
+      # Gets / Sets the gollum page
+      #
+      attr_accessor :gollum_page
+
+      # Sets the validator
+      attr_writer :validator
+
+      # Finds an existing page or creates it
+      #
+      # name - The name
+      # commit - Hash
+      #
+      # Returns self
+      def find_or_initialize_by_name(name, commit)
+        result_for_find = self.find(name)
+        self.create({:format => :markdown, :name => name, :content => ".", :commit => commit })
+      end
+
+      # Checks if the fileformat is supported
+      #
+      # format - String
+      #
+      # Returns true or false
+      def format_supported?(format)
+        supported = ['ascii', 'github-markdown','markdown', 'creole', 'org', 'pod', 'rdoc']
+        format.in?(supported)
+      end
+
+      # first creates an instance of itself and executes the save function.
+      #
+      # hash - Hash containing the page data
+      #
+      #
+      # Returns an instance of Gollum::Page or false
+      def create(hash)
+        page = Page.new hash
+        page.save
+      end
+
+
+      # calls `create` on current class. If returned value is nil an exception will be thrown
+      #
+      # hash - Hash containing the page data
+      #
+      #
+      # Returns an instance of Gollum::Page
+      def create!(hash)
+        action = self.create(hash)
+        action
+      end
+
+      # Finds a page based on the name and specified version
+      #
+      # name - the name of the page
+      #
+      # Return an instance of Gollum::Page
+      def find(name)
+        page = GollumRails::Adapters::Gollum::Page.new
+        page.find_page name
+      end
+
+      # Gets all pages in the wiki
+      def all
+        self.wiki.pages
+      end
+      alias_method :find_all, :all
+
+      # Gets the wiki instance
+      def wiki
+        @wiki || Adapters::Gollum::Connector.wiki_class
+      end
+
+    end
+
+
+    # Initializes a new Page
+    #
+    # attrs - Hash of attributes
+    #
+    # commit must be given to perform any page action!
+    def initialize(attrs = {})
+      if Adapters::Gollum::Connector.enabled
+        attrs.each{|k,v| self.public_send("#{k}=",v)} if attrs
+      else
+        raise GollumInternalError, 'gollum_rails is not enabled!'
+      end
+    end
+
+    #########
+    # Setters
+    #########
+
+
+    # Gets / Sets the pages name
+    attr_accessor :name
+
+    # Gets / Sets the contents content
+    attr_accessor :content
+
+    # Gets / Sets the commit Hash
+    attr_accessor :commit
+
+    # Sets the format
+    attr_writer :format
+
+
+    #########
+    # Getters
+    #########
+
+
+    # Gets the pages format
+    def format
+      @format.to_sym
+    end
+
+
+    # Gets the page class
+    def page
+      @page ||= Adapters::Gollum::Connector.page_class.new
+    end
+
+    #############
+    # activemodel
+    #############
+
+    # Handles the connection betweet plain activemodel and Gollum
+    # Saves current page in GIT wiki
+    # If another page with the same name is existing, gollum_rails
+    # will detect it and returns that page instead.
+    #
+    # Examples:
+    #
+    #   obj = GollumRails::Page.new <params>
+    #   @article = obj.save
+    #   # => Gollum::Page
+    #
+    #   @article.name
+    #   whatever name you have entered OR the name of the previous
+    #   created page
+    #
+    #
+    # TODO:
+    #   * overriding for creation(duplicates)
+    #   * do not alias save! on save
+    #
+    # Returns an instance of Gollum::Page or false
+    def save
+      run_callbacks :save do
+        return false unless valid?
+        begin
+          page.new_page(name,content,format,commit)
+        rescue ::Gollum::DuplicatePageError => e
+          page.page = page.find_page(name)
+        end
+        return page.page
+      end
+    end
+
+    # aliasing save
+    #
+    # TODO:
+    #   * implement full method!
+    alias_method :save!, :save
+
+    # Updates an existing page (or created)
+    #
+    # hash - Hash containing the attributes, you want to update
+    # commit - optional. If given this commit will be used instead of that one, used
+    #          to initialize the instance
+    #
+    #
+    # Returns an instance of Gollum::Page
+    def update_attributes(hash, commit=nil)
+      run_callbacks :update do
+        page.update_page hash, get_right_commit(commit)
+      end
+    end
+
+    # Deletes current page (also available static. See below)
+    #
+    # commit - optional. If given this commit will be used instead of that one, used
+    #          to initialize the instance
+    #
+    # Returns the commit id of the current action as String
+    def delete(commit=nil)
+      run_callbacks :delete do
+        page.delete_page get_right_commit(commit)
+      end
+    end
+
+    # checks if entry already has been saved
+    #
+    #
+    def persisted?
+      return true if page.page.instance_of?(::Gollum::Page)
+      return false
+    end
+    # Previews the page - Mostly used if you want to see what you do before saving
+    #
+    # This is an extremely performant method!
+    # 1 rendering attempt take depending on the content about 0.001 (simple markdown)
+    # upto 0.004 (1000 chars markdown) seconds, which is quite good
+    #
+    #
+    # format - Specify the format you want to render with see {self.format_supported?}
+    #          for formats
+    #
+    # Returns a String
+    def preview(format=:markdown)
+      preview = self.class.wiki.preview_page @name, @content, format
+      preview.formatted_data
+    end
+
+
+    #######
+    private
+    #######
+
+    # Get the right commit out of 2 commits
+    #
+    # commit_local - local commit Hash
+    #
+    # Returns local_commit > class_commit
+    def get_right_commit(commit_local)
+      com = commit if commit_local.nil?
+      com = commit_local if !commit_local.nil?
+      return com
+    end
+
+  end
+ end