gollum_rails 0.0.2.6 → 0.0.2.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gollum_rails (0.0.2.6)
+    gollum_rails (0.0.2.7)
       activemodel (~> 3.2.11)
       builder (~> 3.0.0)
       gollum (~> 2.4.11)

data/HISTORY.md

@@ -1,3 +1,7 @@
+# 0.0.2.7 28th January 2013
+
+* added versioning support
+
 # 0.0.2.5 27th January 2013
 
 * added page preview

data/README.md

@@ -122,7 +122,30 @@ Thats it. Very easy. You can use also `page.save!` method.
 	preview = page.preview("testpage", "content") # or page.preview("testpage", "content", :format)
 	
 	# preview contains the HTML rendered data!
-			
+
+**Show pages versions**
+
+	page = Page.new
+	page.find("testpage")
+	versions = page.versions
+	
+	versions.all
+	# => #<Grit::Commit "83a5e82a58eb4afda2662b7ca665b64554baf431">,
+ 		 #<Grit::Commit "3a12080810acaf5cff3c2fb9bf67821943033548">,
+ 		 #<Grit::Commit "3b9ee74806b5cd59ec7d01fe4d974aa9974c816e">,
+ 		 #<Grit::Commit "c1507f5c47ae5bee16dea3ebed2f177dbcf48a68">,
+
+	
+	versions.latest
+	# => #<Grit::Commit "3a12080810acaf5cff3c2fb9bf67821943033548"> 
+	
+	versions.oldest
+	# => #<Grit::Commit "6d71571d379cfe863933123ea93dea4aac1d6eb64"> 
+	
+	versions.find("6d71571d379cfe86393135ea93dea4aac1d6eb64")	
+	# => #<Grit::Commit "6d71571d379cfe863933123ea93dea4aac1d6eb64"> 
+	
+		
 ## TODO
 * List all pages
 * Search pages

data/Rakefile

@@ -151,11 +151,7 @@ end
 
 desc 'Validate lib files and version file'
 task :validate do
-  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
-  unless libfiles.empty?
-    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
-    exit!
-  end
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}", "lib/generators"]
   unless Dir['VERSION*'].empty?
     puts "A `VERSION` file at root level violates Gem best practices."
     exit!

data/gollum_rails.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
   s.name = 'gollum_rails'
-  s.version = '0.0.2.6'
+  s.version = '0.0.2.7'
 
   s.summary = 'Combines the benefits from Gollum with Rails'
   s.description= 'use templating, authentication and so on'
@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.add_dependency('grit', '~> 2.5.0')
   s.add_dependency('builder', '~> 3.0.0')
   s.add_dependency('rack', '~> 1.4.0')
+  
   s.add_development_dependency('org-ruby', '~> 0.7.2')
   s.add_development_dependency('shoulda', '~> 3.3.2')
   s.add_development_dependency('rack-test', '~> 0.6.2')
@@ -33,12 +34,12 @@ Gem::Specification.new do |s|
     README.md
     Rakefile
     gollum_rails.gemspec
+    lib/generators/gollum_rails/model/model_generator.rb
     lib/gollum_rails.rb
     lib/gollum_rails/config.rb
     lib/gollum_rails/dependency_injector.rb
     lib/gollum_rails/engine.rb
     lib/gollum_rails/file.rb
-    lib/gollum_rails/gollum_rails.rb
     lib/gollum_rails/hash.rb
     lib/gollum_rails/messages.yml
     lib/gollum_rails/page.rb

data/lib/generators/gollum_rails/model/model_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+
+module GollumRails
+  module Generators
+    class ModelGenerator < ::Rails::Generators::Base
+      desc "Install a new model into app/models"
+      argument :model_name, :type => :string
+    end
+  end
+end

data/lib/gollum_rails.rb

@@ -1,13 +1,19 @@
+# ~*~ encoding: utf-8 ~*~
+
+# externals
 require 'rubygems'
 require 'gollum'
 
+# internals
+require File.expand_path('../gollum_rails/engine', __FILE__)
+require File.expand_path('../gollum_rails/dependency_injector', __FILE__)
+require File.expand_path('../gollum_rails/config', __FILE__)
+require File.expand_path('../gollum_rails/wiki', __FILE__)
 
+$KCODE = 'U' if RUBY_VERSION[0,3] == '1.8'
 
-module Gollum
-  module Rails
-  VERSION = '0.0.2.6'
-    require 'gollum_rails/engine' if defined?(Rails)
-  end
-end
+module GollumRails
 
-require 'gollum_rails/gollum_rails' if defined?(Rails)
+  VERSION = '0.0.2.7'
+
+end

data/lib/gollum_rails/engine.rb

@@ -1,11 +1,13 @@
 require 'rails'
-require 'gollum_rails/config'
-  
+
 module GollumRails
-    class Engine < ::Rails::Engine
-      #initialize "gollum_rails.load_app" do |app|
+  class Engine < ::Rails::Engine
+    initializer "gollum_rails.load_app" do |app|
+      puts "abl"
+      #super
       ##   GollumRails::Config::rails = app
-     # end
     end
   end
 
+end
+

data/lib/gollum_rails/page.rb

@@ -1,12 +1,12 @@
 # ~*~ encoding: utf-8 ~*~
-require "gollum_rails/hash"
+require File.expand_path('../hash', __FILE__)
+require File.expand_path('../versions', __FILE__)
 
 module GollumRails
   class Page
     include ActiveModel::Conversion
     include ActiveModel::Validations
     extend ActiveModel::Naming
-    
 
     # Public: Gets/Sets the name of the document
     attr_accessor :name
@@ -73,7 +73,6 @@ module GollumRails
 
     # Public: Gets ?!
     attr_reader :class
-    
     # Public: Initializes a new Page instance
     #
     # attributes - A hash of attributes. See example
@@ -150,14 +149,17 @@ module GollumRails
     def save
       if valid?
         begin
-          @wiki.wiki.write_page(@name, @format, @content, @commit)
-          @persisted = true
+          commit = wiki.wiki.write_page(@name, @format, @content, @commit)
         rescue Gollum::DuplicatePageError => e
           @error = e
           return false
         end
       end
-      return true
+      if commit and commit.is_a? String
+        return commit
+      else
+        return false
+      end
     end
 
     # Public: rewrite for save() method with raising exceptions as well
@@ -198,7 +200,14 @@ module GollumRails
         @error = @options.messages.commit_not_empty_and_content_not_empty
         return false
       end
-      return @wiki.wiki.update_page(@page, @name, @format, content, commit)
+      commit = @wiki.wiki.update_page(@page, @name, @format, content, commit)
+      if commit.is_a?(String)
+        @persisted = true
+        return commit
+      else
+        @persisted = false
+        return nil
+      end
     end
 
     #Public: alias for update with exceptions
@@ -220,7 +229,6 @@ module GollumRails
       return @wiki.wiki.delete_page(@page, commit)
     end
 
-    
     #Public: alias for delete with exceptions
     def delete!(commit)
       deletes = delete(commit)
@@ -237,8 +245,8 @@ module GollumRails
     end
 
     # Public: Renders a preview (usable e.g. with ajax)
-    # 
-    # 
+    #
+    #
     # Returns rendered HTML
     def preview(name = nil, content = nil, format = :markdown)
       if !name or name == nil
@@ -279,7 +287,7 @@ module GollumRails
     attr_reader :page
 
     # Public: Finds a page based on given search string
-    # 
+    #
     # Be careful: At the moment you must initialize the class by .new
     #
     # Examples
@@ -355,7 +363,7 @@ module GollumRails
     # Public: A simple wrapper for Gollum::Page.raw_data
     #
     # Page needs to be loaded!
-    # 
+    #
     # Returns raw data
     def raw_data
       if @page
@@ -381,15 +389,13 @@ module GollumRails
     end
 
     # Public: Active Record like
-    # 
-    # Page.version.first.id
-    # Page.version.first.authored_data
+    #
     #
     #
     # see Active Model documentation
-    def version
-      if @page
-        @page.versions
+    def versions
+      if @page && @page.is_a?(Gollum::Page) #&& (persisted? || found?)
+        return GollumRails::Versions.new(@page)
       else
         @error = @options.messages.no_page_fetched
         return false

data/lib/gollum_rails/versions.rb

@@ -0,0 +1,79 @@
+# ~*~ encoding: utf-8 ~*~
+module GollumRails
+  class Versions
+
+    # Public: Gets the versions
+    attr_reader :versions
+    
+    def initialize(page)
+      @versions = page.versions
+    end
+
+    # Public: .first
+    #
+    # Examples
+    #   oldest
+    #   # => #<Grit::Commit "6d71571d379cfe863933123ea93dea4aac1d6eb64"> 
+    #
+    #
+    # Returns the latest instance of Grit::Commit
+    def latest
+      return @versions.first
+    end
+
+    # Public: Last position in the @versions Array
+    #
+    # Examples
+    #   oldest
+    #   # => #<Grit::Commit "6d71571d379cfe863933123ea93dea4aac1d6eb64"> 
+    #
+    #
+    # Returns the oldest version of Grit::Commit
+    def oldest
+      return @versions.last
+    end
+
+    # Public: An Array of Grit::Commit
+    #
+    #
+    # Examples
+    #   all
+    #   # =>   <Grit::Commit "b3cc54c974700391d3f1c3c108032b6a5f27ecd8">,
+    #          <Grit::Commit "13cda30e2a292852a32fad1e9c547c523387f17e">,
+    #          <Grit::Commit "83a5e82a58eb4afda2662b7ca665b64554baf431">,
+    #          <Grit::Commit "3a12080810acaf5cff3c2fb9bf67821943033548">,
+    #          <Grit::Commit "3b9ee74806b5cd59ec7d01fe4d974aa9974c816e">,
+    #          <Grit::Commit "c1507f5c47ae5bee16dea3ebed2f177dbcf48a68">,
+    #          <Grit::Commit "1979f67c509c2802234dc12f242999953ffd9bc7">,
+    #          <Grit::Commit "01fb119db9cb59b339011c7c9e5e59b89bf9a7a2">,
+    #          <Grit::Commit "650cfd42814cf2d9fd0e2e9b7262f77bad06d0e0">,
+    #          <Grit::Commit "07dfb9a86e7045369fc57c8d43e8cf68d3dfe7d1">,
+    #          ...
+    #
+    # Returns many instances of Grit::Commit
+    def all
+      return @versions
+    end
+
+    # Public: Find a specific version
+    #
+    # version - String, containing the GIT version number
+    #
+    # Examples
+    #   find '6d71571d379cfe86393135ea93dea4aac1d6eb64'
+    #   # => #<Grit::Commit "6d71571d379cfe86393135ea93dea4aac1d6eb64">
+    #
+    #
+    # Returns an instance of Gollum::Page
+    def find(version = String.new)
+      result = nil
+      @versions.each do |commit|
+        if commit.id == version
+          result = commit
+        end
+      end
+      return result
+    end
+    
+  end
+end

data/lib/gollum_rails/wiki.rb

@@ -1,32 +1,36 @@
+require File.expand_path('../validations', __FILE__)
+require File.expand_path('../file', __FILE__)
+require File.expand_path('../page', __FILE__)
+
 module GollumRails
-    class Wiki
-      attr_accessor :wiki
-      def initialize(path)
-        main = getMainGollum(path)
-        send("wiki=", main)
-        DependencyInjector.set({:wiki => self})
-      end
-
-      def getMainGollum(path)
-        wiki = Gollum::Wiki.new(path)
-      end
-
-      def getPath
-        @wiki.path
-      end
-
-      def getRepo
-        @wiki.repo
-      end
-
-      def search(string = '')
-
-      end
-      
-      ## static setters / getters
-      
-      def self.getWiki
-        @wiki
-      end
+  class Wiki
+    attr_accessor :wiki
+    def initialize(path)
+      main = getMainGollum(path)
+      send("wiki=", main)
+      DependencyInjector.set({:wiki => self})
+    end
+
+    def getMainGollum(path)
+      wiki = Gollum::Wiki.new(path)
+    end
+
+    def getPath
+      @wiki.path
+    end
+
+    def getRepo
+      @wiki.repo
+    end
+
+    def search(string = '')
+
+    end
+
+    ## static setters / getters
+
+    def self.getWiki
+      @wiki
     end
-  end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2.6
+  version: 0.0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -184,12 +184,12 @@ files:
 - README.md
 - Rakefile
 - gollum_rails.gemspec
+- lib/generators/gollum_rails/model/model_generator.rb
 - lib/gollum_rails.rb
 - lib/gollum_rails/config.rb
 - lib/gollum_rails/dependency_injector.rb
 - lib/gollum_rails/engine.rb
 - lib/gollum_rails/file.rb
-- lib/gollum_rails/gollum_rails.rb
 - lib/gollum_rails/hash.rb
 - lib/gollum_rails/messages.yml
 - lib/gollum_rails/page.rb
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 380323827
+      hash: 182668687
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/lib/gollum_rails/gollum_rails.rb

@@ -1,8 +0,0 @@
-require "gollum_rails/engine"
-require 'gollum_rails/config'
-require "gollum_rails/dependency_injector"
-require "gollum_rails/wiki"
-require "gollum_rails/page"
-require 'gollum_rails/file'
-require 'gollum_rails/versions'
-require 'gollum_rails/validations'