gollum_rails 1.5.10 → 1.5.12

data/lib/gollum_rails/core.rb

@@ -1,9 +1,8 @@
 module GollumRails
   module Core
     extend ActiveSupport::Concern
-    
     module ClassMethods
-      
+
       # Checks if the fileformat is supported
       #
       # format - String
@@ -12,7 +11,7 @@ module GollumRails
       def format_supported?(format)
         Gollum::Markup.formats.include?(format.to_sym)
       end
-      
+
       # Resets the folder to /
       def reset_folder
         set_folder(nil)
@@ -32,7 +31,7 @@ module GollumRails
       end
       alias_method :folder=, :set_folder
     end
-    
+
     # Initializes a new Page
     #
     # attrs - Hash of attributes
@@ -45,7 +44,6 @@ module GollumRails
       run_callbacks :initialize unless _initialize_callbacks.empty?
     end
 
-
     # Allows you to set all the attributes by passing in a hash of attributes with
     # keys matching the attribute name
     #
@@ -55,15 +53,12 @@ module GollumRails
         raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
       end
       return if new_attributes.blank?
-
       attributes = new_attributes.stringify_keys
       attributes.each do |k, v|
         _assign_attribute(k, v)
       end
     end
-    
 
-    
     def url_path #:nodoc:
       File.split(url)
     end
@@ -86,11 +81,11 @@ module GollumRails
       Gollum::Page.cname(self.name)
     end
 
-    # Gets a canonicalized filename of the page 
+    # Gets a canonicalized filename of the page
     def canonicalized_filename
       Gollum::Page.canonicalize_filename(name)
     end
-    
+
     # == Previews the page - Mostly used if you want to see what you do before saving
     #
     # This is an extremely fast method!
@@ -103,10 +98,9 @@ module GollumRails
     #
     # Returns a String
     def preview(format=:markdown)
-      wiki.preview_page(name, content, format).formatted_data
+      require 'active_support/core_ext/string/output_safety'
+      wiki.preview_page(name, content, format).formatted_data.html_safe
     end
-    
-    
 
     # == Gets the url for current page from Gollum::Page
     #
@@ -116,15 +110,14 @@ module GollumRails
         gollum_page.url_path
       end
     end
-    
+
     # == Gets the title for current Gollum::Page
     #
     # Returns a String
     def title
       gollum_page.title
     end
-    
-    
+
     # == Gets formatted_data for current Gollum::Page
     #
     # Returns a String
@@ -137,7 +130,7 @@ module GollumRails
     def raw_data
       gollum_page.raw_data
     end
-    
+
     # == Gets the history of current gollum_page
     #
     # Returns an Array
@@ -145,14 +138,14 @@ module GollumRails
       return nil unless persisted?
       gollum_page.versions
     end
-    
+
     # == Gets the last modified by Gollum::Committer
     #
     # Returns a String
     def last_changed_by
-      "%s <%s>" % [history.last.author.name, history.last.author.email]
+      "%s <%s>" % [history.first.author.name, history.first.author.email]
     end
-    
+
     # == Compare 2 Commits.
     #
     # sha1 - SHA1
@@ -161,34 +154,26 @@ module GollumRails
       Page.wiki.full_reverse_diff_for(@gollum_page,sha1,sha2)
     end
 
-    
-    # == The pages filename, based on the name and the format
-    # 
-    # Returns a String
-    # def filename
-    #   Page.wiki.page_file_name(@name, @format)
-    # end
-      
     # == Checks if current page is a subpage
     def sub_page?
       return nil unless persisted?
       @gollum_page.sub_page
     end
-    
+
     # == Gets the version of current commit
     #
     def current_version(long=false)
       return nil unless persisted?
       unless long
-        @gollum_page.version_short 
+        @gollum_page.version_short
       else
         @gollum_page.version.to_s
       end
-      
+
     end
-    
+
     private
-    
+
     # == Gets the right commit out of 2 commits
     #
     # commit_local - local commit Hash
@@ -202,19 +187,19 @@ module GollumRails
 
     def _assign_attribute(key, value)
       public_send("#{key}=", value)
-    rescue NoMethodEr3ror
+    rescue NoMethodError
       if respond_to?("#{key}=")
         raise
       end
     end
-    
+
     # == Updates local attributes from gollum_page class
     #
     def _update_page_attributes
       @name = gollum_page.name
       @content= gollum_page.raw_data
-      @format = gollum_page.format      
+      @format = gollum_page.format
     end
-    
+
   end
 end

data/lib/gollum_rails/error.rb

@@ -1,6 +1,5 @@
 module GollumRails
   class InitializationError < StandardError; end
-  
   module Error
   end
-end
+end

data/lib/gollum_rails/finders.rb

@@ -1,9 +1,9 @@
 module GollumRails
   module Finders
     extend ActiveSupport::Concern
-
     module ClassMethods
-      # Finds an existing page or creates it
+
+      # Find an existing page or create it
       #
       # name - The name
       # commit - Hash
@@ -17,7 +17,7 @@ module GollumRails
           new(:format => :markdown, :name => name, :content => ".", :commit => commit)
         end
       end
-      
+
       # Finds a page based on the name and specified version
       #
       # name - the name of the page
@@ -43,7 +43,7 @@ module GollumRails
           nil
         end
       end
-      
+
       # == Searches the wiki for files CONTENT!
       #
       # string - Searchstring
@@ -63,7 +63,7 @@ module GollumRails
           self.new(gollum_page: page)
         end
       end
-      
+
       # Gets the last item from `all` method call
       #
       # options - optional - some options e.g. :folder
@@ -72,7 +72,7 @@ module GollumRails
       def first(options={})
         all(options).first
       end
-      
+
       # Gets the first item from `all` method call
       #
       # options - optional - some options e.g. :folder
@@ -81,10 +81,10 @@ module GollumRails
       def last(options={})
         all(options).last
       end
-      
+
       # Aliasing this for ActiveRecord behavior
       alias_method :find_all, :all
-      
+
       # Catch-all method
       def method_missing(name, *args)
         if name =~ /^find_by_(name)$/
@@ -92,8 +92,6 @@ module GollumRails
         else super
         end
       end
-      
-      
     end
   end
 end

data/lib/gollum_rails/meta.rb

@@ -1,10 +1,10 @@
 module GollumRails
   module Meta
     extend ActiveSupport::Concern
-    
+
     # == Checks if this page has a Yaml part
     #
-    # Example YAML part: 
+    # Example YAML part:
     #
     # ---
     # title: "My Page"
@@ -26,7 +26,7 @@ module GollumRails
     def raw_meta
       raw_data.match(/^(?<headers>---\s*\n.*?\n?)^(---\s*$\n?)/m).to_s
     end
-    
+
     # == Gets the parsed meta data
     #
     #
@@ -36,8 +36,7 @@ module GollumRails
     rescue Psych::SyntaxError => e
       {error: e}
     end
-    
-    
+
     # == Example for meta data usage:
     #
     # Gets the title from the meta data
@@ -53,6 +52,6 @@ module GollumRails
     def html_without_yaml
       gollum_page.markup_class.render(raw_data.tap{|s| s.slice!(raw_meta.to_s)})
     end
-    
+
   end
-end
+end

data/lib/gollum_rails/orm.rb

@@ -2,11 +2,8 @@ module GollumRails
   # Playground
   module Orm
     extend ActiveSupport::Concern
-    
     def save
-      
       super
     end
-    
   end
-end
+end

data/lib/gollum_rails/page.rb

@@ -1,11 +1,11 @@
 module GollumRails
-  
-  
+
+
   # = GollumRails
   #
   # Gollum Rails was initially designed to integrate the Gollum wiki software
   # into your Rails application without any mounts or extra applications to run.
-  # 
+  #
   # Now you can use your completely own layout without struggling with gollum forks.
   #
   # Just integrate this gem into your Gemfile and you are good to go:
@@ -18,7 +18,7 @@ module GollumRails
   #
   #
   # If you want to use this gem with Rails version prior 4.0.0 please check out the rails3
-  # branch on Github: 
+  # branch on Github:
   #
   # https://github.com/nirnanaaa/gollum_rails/tree/rails3
   #
@@ -48,7 +48,7 @@ module GollumRails
   #
   #   commit = { name: 'nirnanaa', email: 'mosny@zyg.li', message: 'created page page'}
   #   Page.create(name: 'test_page', content: 'content', format: :markdown, commit: commit)
-  #   
+  #
   #   Page.create!(name: 'test_page', content: 'content', format: :markdown, commit: commit)
   #
   # The <tt>!</tt> version of the method throws an error on failure.
@@ -65,7 +65,6 @@ module GollumRails
   #
   #
   class Page
-    
     if ActiveModel::VERSION::MAJOR == 4
       include ActiveModel::Model
     else
@@ -74,7 +73,6 @@ module GollumRails
       include ActiveModel::Conversion
       include ActiveModel::Validations
     end
-    
     include Error
     include Core
     include Meta
@@ -83,9 +81,6 @@ module GollumRails
     include Persistance
     include Finders
     include Callbacks
-
   end
-  
   ActiveSupport.run_load_hooks(:gollum, Page)
-  
- end
+end

data/lib/gollum_rails/persistance.rb

@@ -1,9 +1,11 @@
 module GollumRails
   module Persistance
     extend ActiveSupport::Concern
-    
+
+    class AttributeMissingError < NoMethodError; end
+
     module ClassMethods
-      
+
       # first creates an instance of itself and executes the save function.
       #
       # data - Hash containing the page data
@@ -15,7 +17,6 @@ module GollumRails
         page.save
       end
 
-
       # calls `create` on current class. If returned value is nil an exception will be thrown
       #
       # data - Hash of Data containing all necessary stuff
@@ -27,7 +28,7 @@ module GollumRails
         page = self.new(data)
         page.save!
       end
-      
+
     end
     #############
     # activemodel
@@ -58,7 +59,7 @@ module GollumRails
       return nil unless valid?
       begin
         create_or_update
-      rescue ::Gollum::DuplicatePageError => e
+      rescue ::Gollum::DuplicatePageError
       end
       self.gollum_page = wiki.paged(file_name, path_name, true, wiki.ref)
       _update_page_attributes
@@ -66,15 +67,16 @@ module GollumRails
     end
 
     # == Save without exception handling
-    # raises errors everytime something is wrong 
+    # raises errors everytime something is wrong
     #
+    # Returns an instance of GollumRails::Page
     def save!
       raise StandardError, "record is not valid" unless valid?
       raise StandardError, "commit must not be empty" if commit == {}
       create_or_update
       self
     end
-    
+
     # == Creates a record or updates it!
     #
     # Returns a Commit id string
@@ -85,30 +87,30 @@ module GollumRails
         create_record
       end
     end
-    
+
     # == Creates a record
     #
     # Returns a Commit id
     def create_record
-      wiki.write_page(canonicalized_filename, format, content, commit, path_name) 
+      wiki.write_page(canonicalized_filename, format, content, commit, path_name)
       wiki.clear_cache
+    rescue NoMethodError => e
+      raise AttributeMissingError, "Attributes are missing. Error message: <%s>" % e.message
     end
-    
+
     # == Update a record
     #
-    # NYI
+    # Updates a record based on current instance variables
     #
     # returns a Commit id
     def update_record
       wiki.update_page(self.gollum_page,
                        self.name,
-                       self.format, 
+                       self.format,
                        self.content,
                        self.commit)
     end
-    
-    
-    
+
     # == Updates an existing page (or created)
     #
     # attributes - Hash of arguments
@@ -118,8 +120,8 @@ module GollumRails
       assign_attributes(attributes)
       save
     end
-    
-    def seperate_path(path)
+
+    def seperate_path(path) #:nodoc:
       path = File.split(name)
       if path.first == '/' || path.first == '.'
         folder = nil
@@ -128,7 +130,6 @@ module GollumRails
       end
     end
 
-    
     # == Deletes current page
     #
     # commit - optional. If given this commit will be used instead of that one, used
@@ -157,17 +158,5 @@ module GollumRails
       return true if gollum_page
       return false
     end
-    
-
-    
-    
-    # == Checks if the page is valid
-    #
-    #    # 
-    # def valid?
-    #   #if Gollum::Page.valid_page_name?(self.name)
-    # end
-    
-    
   end
 end