gollum_rails 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac973e7abd2f4b27cdc5568448bc2b604a8a43bc
-  data.tar.gz: b8dbaa9689b6ac1ada39efc362dea305a3fe00ef
+  metadata.gz: f5e3515f14116b1aeb5ed2717b76293cbd1548e7
+  data.tar.gz: 6de8ad0cee8e27e0d800f2ac323ed1182ae85b7f
 SHA512:
-  metadata.gz: 02ce3f25360dd389980da220ec91ce2f8a08abccb56799933e705523da96beccf5031ead746a3f24495d713db7b64bb46287f3919e8963e1ac118da3fe75ff7e
-  data.tar.gz: d4a7a8b643cfbf61a6c57e3f48eadac25d6434978ba972a2e288cbeac6824198cc349bd272d38b05f6e7ec3ce71147c49ad5369beb1d27dde8e91413a7a83fbf
+  metadata.gz: c27bc643db23fdcd0c22847dfc202b32f9215e54fa48e67e48500a9a0b8733b41352bca8d27b064d9501f40aa62e64ff25b53596bee6946cdcf2a6d0a1bae7ff
+  data.tar.gz: a15689feba2f801ea6f6de6eacd37ebb71833d00c9c075dc19eaa9be66572fb93883af8486cb668edf76b57acaa36f2dd97e5503e6919fef8f12dc96ce0f0e9d

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'coveralls', require: false
-
+gem 'guard'
+gem 'guard-rspec'
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gollum_rails (1.4.2)
+    gollum_rails (1.4.3)
       activemodel (>= 4.0.0)
       gollum-lib (~> 1.0.4)
 
@@ -35,6 +35,7 @@ GEM
     arel (4.0.0)
     atomic (1.1.9)
     builder (3.1.4)
+    coderay (1.0.9)
     colorize (0.5.8)
     coveralls (0.6.4)
       colorize
@@ -44,6 +45,8 @@ GEM
       thor
     diff-lcs (1.2.4)
     erubis (2.7.0)
+    ffi (1.9.0)
+    formatador (0.2.4)
     github-markdown (0.5.3)
     github-markup (0.7.5)
     gollum-lib (1.0.4)
@@ -58,11 +61,26 @@ GEM
       diff-lcs (~> 1.1)
       mime-types (~> 1.15)
       posix-spawn (~> 0.3.6)
+    guard (1.8.0)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.1)
+      guard (>= 1.8)
+      rspec (~> 2.13)
     hike (1.2.3)
     i18n (0.6.4)
+    listen (1.1.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.3)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
+    method_source (0.8.1)
     mime-types (1.23)
     mini_portile (0.5.1)
     minitest (4.7.5)
@@ -71,6 +89,10 @@ GEM
       mini_portile (~> 0.5.0)
     polyglot (0.3.3)
     posix-spawn (0.3.6)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     pygments.rb (0.5.2)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.1.0)
@@ -91,6 +113,11 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rr (1.1.1)
@@ -108,6 +135,7 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
+    slop (3.4.5)
     sprockets (2.10.0)
       hike (~> 1.2)
       multi_json (~> 1.0)
@@ -134,6 +162,8 @@ PLATFORMS
 DEPENDENCIES
   coveralls
   gollum_rails!
+  guard
+  guard-rspec
   rails (>= 4.0.0)
   rr (~> 1.1.1)
   rspec (~> 2.13.0)

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/HISTORY.md

@@ -1,3 +1,15 @@
+# 1.4.3 1th September 2013
+* Display the current pages version (short OR long)
+* Display if the page is a sub page
+* Display the pages filename
+* Improved specs
+* Refactored find method to return nil if no page was found (BUG)
+* Refactored find_or_initialize_by_name to be useable :)
+* Returning nil on history if a page was not saved
+* Added finding with version string
+* Using activemodel convenient `destroy` and deprecated old `delete`
+* Added callback for initializer
+
 # 1.4.2 1th August 2013
 * Found an issue that the Wiki was not updating from external pushes
 * Some helper methods implemented

data/README.md

@@ -28,6 +28,7 @@ with gollum_rails you can:
 ## [Usage](https://github.com/nirnanaaa/gollum_rails/wiki/Usage)
 
 
+
 ## DEVELOPER
 
 Very cool. Just fork this repository and send me pull requests.

data/gollum_rails.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.name = 'gollum_rails'
   s.rubyforge_project = s.name
 
-  s.version = '1.4.2'
+  s.version = '1.4.3'
 
   s.summary = 'Combines Gollum and Rails'
   s.description= 'include Gollum into Rails with ease'
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.files = %w[
     Gemfile
     Gemfile.lock
+    Guardfile
     HISTORY.md
     LICENSE
     README.md
@@ -65,7 +66,6 @@ Gem::Specification.new do |s|
     spec/gollum_rails/respository_spec.rb
     spec/gollum_rails/setup_spec.rb
     spec/gollum_rails/wiki_spec.rb
-    spec/spec.opts
     spec/spec_helper.rb
   ]
   # = MANIFEST =

data/lib/gollum_rails.rb

@@ -23,7 +23,7 @@ module GollumRails
   autoload :Setup,    'gollum_rails/setup'
 
   # GollumRails version string
-  VERSION = '1.4.2'
+  VERSION = '1.4.3'
 
   # Simplified error
   class Error < StandardError; end

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

@@ -41,11 +41,13 @@ module GollumRails
           #
           # name - the pagename to search
           # wiki - instance of Gollum::Wiki
+          # version - optional - The pages version
           #
           # Returns the Gollum::Page class
-          def find_page(name, wiki)
+          def find_page(name, wiki, version=nil)
+            wiki.clear_cache
             path_data = parse_path(name)
-            wiki.paged(path_data[:name], path_data[:path], exact = true)
+            wiki.paged(path_data[:name], path_data[:path], exact = true, version)
           end
         end
 
@@ -61,6 +63,7 @@ module GollumRails
         def new_page( name, content, wiki, type=:markdown, commit={} )
           path_data = self.class.parse_path(name)
           wiki.write_page( path_data[:name], type, content, commit, path_data[:path].gsub!(/^\//, "").gsub!(/(\/)+$/,'') || "" )
+          wiki.clear_cache
           self.class.find_page( name, wiki )
         end
 
@@ -75,11 +78,14 @@ module GollumRails
         #
         # Returns the page
         def update_page( page, wiki, content=nil, commit={}, name=nil, format=nil)
-          return if !page || ((!content||page.raw_data == content) && page.format == format)
+          wiki.clear_cache
+          return page if page.nil?
           name ||= page.name
           format = (format || page.format).to_sym
           content ||= page.raw_data
-          wiki.update_page(page,name,format,content.to_s,commit)
+          
+          wiki.update_page(page,name,format,content.to_s,commit) unless ((!content||page.raw_data == content) && page.format == format)
+          
           self.class.find_page( mixin(page.url_path, name), wiki )
         end
         
@@ -103,6 +109,7 @@ module GollumRails
         #
         # Returns the commit id
         def delete_page( page,wiki,commit={} )
+          wiki.clear_cache
           wiki.delete_page(page, commit)
         end
         
@@ -123,6 +130,7 @@ module GollumRails
         #
         # Returns the Gollum::Page class
         def find_page(name)
+          
           self.class.find_page(name)
         end
         

data/lib/gollum_rails/page.rb

@@ -45,9 +45,13 @@ module GollumRails
       # commit - Hash
       #
       # Returns self
-      def find_or_initialize_by_name(name, commit)
+      def find_or_initialize_by_name(name, commit={})
         result_for_find = find(name)
-        create({:format => :markdown, :name => name, :content => ".", :commit => commit })
+        unless result_for_find.nil?
+          result_for_find
+        else
+          new(:format => :markdown, :name => name, :content => ".", :commit => commit)
+        end
       end
 
       # Checks if the fileformat is supported
@@ -56,8 +60,7 @@ module GollumRails
       #
       # Returns true or false
       def format_supported?(format)
-        supported = ['ascii', 'github-markdown','markdown', 'creole', 'org', 'pod', 'rdoc']
-        format.in?(supported)
+        Gollum::Markup.formats.include?(format.to_sym)
       end
 
       # first creates an instance of itself and executes the save function.
@@ -87,10 +90,15 @@ module GollumRails
       # Finds a page based on the name and specified version
       #
       # name - the name of the page
+      # version - optional - The pages version
       #
       # Return an instance of Gollum::Page
-      def find(name)
-        self.new(gollum_page: Adapters::Gollum::Page.find_page(name, wiki))
+      def find(name, version=nil)
+        page = Adapters::Gollum::Page.find_page(name, wiki, version)
+        
+        return new( :gollum_page => page ) unless page.nil?
+        return nil
+        
       end
 
       # Gets all pages in the wiki
@@ -127,11 +135,13 @@ module GollumRails
     #
     # 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
-        update_attrs if attrs[:gollum_page]
-      else
-        raise GollumInternalError, 'gollum_rails is not enabled!'
+      run_callbacks :initialize do
+        if Adapters::Gollum::Connector.enabled
+          attrs.each{|k,v| self.public_send("#{k}=",v)} if attrs
+          update_attrs if attrs[:gollum_page]
+        else
+          raise GollumInternalError, 'gollum_rails is not enabled!'
+        end
       end
     end
 
@@ -141,10 +151,10 @@ module GollumRails
 
 
     # Gets / Sets the pages name
-    attr_accessor :name
+    attr_writer :name
 
     # Gets / Sets the contents content
-    attr_accessor :content
+    attr_writer :content
 
     # Gets / Sets the commit Hash
     attr_accessor :commit
@@ -160,9 +170,16 @@ module GollumRails
 
     # Gets the pages format
     def format
-      @format.to_sym
+      (@format || @gollum_page.format).to_sym
     end
 
+    def name
+      @name ||= @gollum_page.name
+    end
+    
+    def content
+      @content ||= @gollum_page.content
+    end
 
     # Gets the page class
     def page
@@ -236,19 +253,29 @@ module GollumRails
         @gollum_page = page.update_page(gollum_page, wiki, content, get_right_commit(commit), name, format)
       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)
+    def destroy(commit=nil)
       run_callbacks :delete do
         page.delete_page(gollum_page, wiki, 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)
+      destroy(commit)
+    end
+
     # checks if entry already has been saved
     #
     #
@@ -305,6 +332,7 @@ module GollumRails
     #
     # Returns an Array
     def history
+      return nil unless persisted?
       gollum_page.versions
     end
     
@@ -315,11 +343,38 @@ module GollumRails
       "%s <%s>" % [history.last.author.name, history.last.author.email]
     end
     
+    # == Compare 2 Commits.
+    #
+    # sha1 - SHA1
+    # sha2 - SHA1
+    def compare_commits(sha1,sha2=nil)
+      Page.wiki.full_reverse_diff_for(@gollum_page,sha1,sha2)
+    end
     
-    def compare_commits(sha1,sha2)
-      puts "NOT YET IMPLEMENTED"
+    # == 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 
+      else
+        @gollum_page.version.to_s
+      end
+      
+    end
     
     #######
     private

data/spec/gollum_rails/page_spec.rb

@@ -137,25 +137,45 @@ describe "Gollum Page" do
       expect{RailsModel.create! @call}.to raise_error Gollum::DuplicatePageError
     end
 
-    it "should test the supported formats" do
-      RailsModel.format_supported?('ascii').should be_true
-      RailsModel.format_supported?('markdown').should be_true
-      RailsModel.format_supported?('github-markdown').should be_true
-      RailsModel.format_supported?('rdoc').should be_true
-      RailsModel.format_supported?('org').should be_true
-      RailsModel.format_supported?('pod').should be_true
+    describe "supported formats" do
+      ['markdown', 'rdoc', 'org', 'pod'].each do |format|
+        it "should support #{format}" do
+          RailsModel.format_supported?(format).should be_true
+        end
+      end
+      
     end
-
-    it "should test getters" do
-      rr = RailsModel.new @call
-      rr.name.should == "Goole"
-      rr.content.should == "content data"
-      rr.commit.should be_a Hash
-      rr.commit.should == @commit
-      rr.format.should == :markdown
-      rr.save
-      rr.page.should be_a GollumRails::Adapters::Gollum::Page
+    
+    describe "accessors" do
+      let(:rr){RailsModel.new @call}
+      
+      it "should have a name" do
+        expect(rr.name).to match(/^Goole$/)
+      end
+      
+      it "should have a content" do
+        expect(rr.content).to match(/^content\ data$/)
+      end
+      
+      it "should have a commit which is a Hash" do
+        expect(rr.commit).to be_a Hash
+      end
+      
+      it "should be @commit" do
+        expect(rr.commit).to be(@commit)
+      end
+      
+      it "should have a format" do
+        expect(rr.format.to_s).to match('markdown')
+      end
+      
+      it "should be a Gollum::Page after save" do
+        rr.save
+        expect(rr.gollum_page).to be_a Gollum::Page
+      end
+      
     end
+    
     it "should test setters" do
       rr = RailsModel.new
       rr.name=("google").should == "google"
@@ -163,12 +183,34 @@ describe "Gollum Page" do
       rr.content=("content").should == "content"
       rr.format=(:markdown).should == :markdown
     end
-
-
-    it "should test find or initialize" do
-      rr = RailsModel.new @call
-      rr.save
-      RailsModel.find_or_initialize_by_name(@call[:name], @commit).should  be_a GollumRails::Page
+    
+    it "tests the find method to return nil if no page was found" do
+      expect(RailsModel.find('whoooohoo')).to be_nil
+    end
+    
+    it "tests the find method to return a gollum_rails:page if a page was found" do
+      expect(RailsModel.find('Goole')).to be_a GollumRails::Page
+    end
+    
+    it 'should not be persisted on initialization or finding' do
+      init = RailsModel.find_or_initialize_by_name('totallybad', @commit)
+      expect(init.persisted?).to be_false
+    end
+    
+    it "should find the page without a commit if it exists" do
+      expect(RailsModel.find_or_initialize_by_name("Goole").persisted?).to be_true
+    end
+    
+    it "should find the page with a commit if it exists" do
+      expect(RailsModel.find_or_initialize_by_name("Goole", @commit).persisted?).to be_true
+    end
+    
+    it "should be valid on initialization or finding" do
+      init = RailsModel.find_or_initialize_by_name('whoooohooo', @commit)
+      expect(init.valid?).to be_true
+      
+      #RailsModel.find_or_initialize_by_name(@call[:name], @commit).should  be_a GollumRails::Page
+      
     end
   end
   describe "callbacks" do
@@ -237,29 +279,35 @@ describe "Gollum Page" do
      class Callbackt < GollumRails::Page
       validates_presence_of :name
      end
+     
      cla = Callbackt.new @call
      cla.valid?.should be_true
    end
+   
    class SugarBaby < GollumRails::Page
      validates_presence_of :name
      validates_length_of :name, :minimum => 20
      validates_length_of :format, :maximum => 14
    end
+   
    it "should test string validation" do
      @call[:name] = "das ist zu lang"*10
      cla = SugarBaby.new @call
      cla.valid?.should be_true
    end
+   
    it "should test the presence validator" do
      @call[:name] = [ ]
      bla = SugarBaby.new @call
      bla.valid?.should be_false
    end
+   
    it "should test the length validator for name" do
      @call[:name] = "das"
      res = SugarBaby.new @call
      res.valid?.should be_false
    end
+   
    it "should test the length validator for format" do
      @call[:format] = :toolongformatstringforvalidator
      res = SugarBaby.new @call
@@ -267,21 +315,131 @@ describe "Gollum Page" do
    end
 
   end
- describe "the thread safety" do
-   class ThreadModel < GollumRails::Page
-
-   end
-   it "should save " do
-     100.times do |time|
-       Thread.new do
-         ThreadModel.new(@call)
-         ThreadModel.save.should be_a(GollumRails::Page)
-         ThreadModel.delete(@commit).length.should == 40
-       end
-     end
-
-   end
-
+  
+  describe "diffing commits" do
+    class CommitDiff < GollumRails::Page
+    end
+    
+    it "should display the diff commit" do
+      commit = {
+        name: "flo",
+        message: "commit",
+        email: "mosny@zyg.li"
+      }
+      call = {
+        name: "a Page",
+        content: "my content",
+        commit: commit,
+        format: :markdown
+      }
+      
+      res = CommitDiff.new call
+      res.save
+      res.update_attributes("content",nil,:markdown, @commit)
+      diff = res.compare_commits(res.history.first)
+      expect(diff).to be_a String
+      expect(diff).to match(/diff/)
+      res.delete
+    end
+    
+  end
+  
+  describe "Filename" do
+    class Fns < GollumRails::Page
+    end
+    it "should assemble a filename" do
+      res = CommitDiff.new @call
+      expect(res.filename).to match(/^Goole\.md$/)
+    end
+  end
+  
+  describe "Sub Page" do
+    class Fns < GollumRails::Page
+    end
+    
+    it "should return nil if not persisted" do
+      res = CommitDiff.new @call
+      expect(res.sub_page?).to be_nil
+    end
+    it "should be true" do
+      res = CommitDiff.new @call.merge(name: '_aPage')
+      res.save
+      expect(res.sub_page?).to be_true
+      res.delete
+    end
+    
+    it "should be false" do
+      res = CommitDiff.new @call
+      res.save
+      expect(res.sub_page?).to be_false
+      res.delete
+    end
+  end  
+  
+  describe "Current version" do
+    class Fns < GollumRails::Page
+    end
+    
+    it "current version should have 7 digest" do
+      res = CommitDiff.new @call
+      res.save
+      expect(res.current_version.length).to be(7)
+      res.delete
+    end
+    
+    it "should be nil if page has not been set" do
+      res = CommitDiff.new @call
+      expect(res.current_version).to be_nil
+    end
 
-end
+    it "should be the latest version of the page but shortened" do
+      res = CommitDiff.new @call
+      res.save
+      expect(res.gollum_page.version.to_s).to match(res.current_version)
+      res.delete
+    end
+    it "should display the long version" do
+      res = CommitDiff.new @call
+      res.save
+      expect(res.gollum_page.version.to_s).to match(/^#{res.current_version(true)}$/)
+      res.delete
+    end
+    
+  end
+  
+  describe 'History' do
+    class Fns < GollumRails::Page
+    end
+    
+    it "history should return nil if no gollum_page was saved" do
+      res = Fns.new @call
+      expect(res.history).to be_nil
+    end
+    
+    it "history should return the pages versions if there are changes" do
+      res = Fns.new @call
+      res.save
+      expect(res.history).to be_a Array
+      res.delete
+    end
+    
+  end
+  
+ # describe "the thread safety" do
+#    class ThreadModel < GollumRails::Page
+# 
+#    end
+#    it "should save " do
+#      100.times do |time|
+#        Thread.new do
+#          ThreadModel.new(@call)
+#          ThreadModel.save.should be_a(GollumRails::Page)
+#          ThreadModel.delete(@commit).length.should == 40
+#        end
+#      end
+# 
+#    end
+
+
+#end
 end

data/spec/spec_helper.rb

@@ -7,37 +7,14 @@ Coveralls.wear!
 require 'gollum_rails'
 
 
-require 'benchmark'
-RSpec::Matchers.define :take_less_than do |n|
-  chain :seconds do; end
-    match do |block|
-      @elapsed = Benchmark.realtime do
-        block.call
-      end
-      @elapsed <= n
-    end
-end
 
 RSpec.configure do |config|
  config.treat_symbols_as_metadata_keys_with_true_values = true
 
- config.backtrace_clean_patterns = [
-  /\/lib\d*\/ruby\//,
-  /bin\//,
-  /gems/,
-  /spec\/spec_helper\.rb/,
-  /lib\/rspec\/(core|expectations|matchers|mocks)/
- ]
  config.before(:each) do
    GollumRails::Adapters::Gollum::Connector.enabled = true
  end
- config.full_backtrace= false # save the console
- config.color_enabled= true   # save your eyes
- config.formatter = :documentation
 
  config.mock_with :rr
-
- config.before(:each) do
- end
  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gollum_rails
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Florian Kasper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-27 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -88,6 +88,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - HISTORY.md
 - LICENSE
 - README.md
@@ -125,7 +126,6 @@ files:
 - spec/gollum_rails/respository_spec.rb
 - spec/gollum_rails/setup_spec.rb
 - spec/gollum_rails/wiki_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 homepage: https://github.com/nirnanaaa/gollum_rails
 licenses:

data/spec/spec.opts

@@ -1,3 +0,0 @@
---color
---format progress
-