confluencer 0.3.1 → 0.4.1

data/.document

@@ -1,5 +1,3 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
+README
 LICENSE
+lib/**/*.rb

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/rgabo/confluencer"
     gem.authors = ["Gabor Ratky"]
     gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_runtime_dependency "log4r", ">= 1.1.7"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.1

data/confluencer.gems

@@ -2,6 +2,7 @@
 gemcutter -v0.5.0
 git -v1.2.5
 jeweler -v1.4.0
-json_pure -v1.4.2
+json_pure -v1.4.3
+log4r -v1.1.7
 rspec -v1.3.0
 rubyforge -v2.0.4

data/confluencer.gemspec

@@ -5,23 +5,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{confluencer}
-  s.version = "0.3.1"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gabor Ratky"]
-  s.date = %q{2010-05-12}
+  s.date = %q{2010-05-13}
   s.description = %q{ActiveRecord-like classes to access Confluence through XMLRPC.}
   s.email = %q{rgabo@rgabostyle.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README"
   ]
   s.files = [
     ".document",
      ".gitignore",
      ".rvmrc",
      "LICENSE",
-     "README.rdoc",
+     "README",
      "Rakefile",
      "VERSION",
      "confluencer.gems",
@@ -71,11 +71,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_runtime_dependency(%q<log4r>, [">= 1.1.7"])
     else
       s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<log4r>, [">= 1.1.7"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<log4r>, [">= 1.1.7"])
   end
 end
 

data/lib/confluence/bookmark.rb

@@ -1,33 +1,32 @@
 module Confluence
   class Bookmark < Page
-    attr_reader :bookmark_url, :description
+    attr_accessor :bookmark_url, :description
 
     def initialize(hash)
-      super(hash)
+      # set and delete bookmark_url and description
+      @bookmark_url = hash.delete :bookmark_url
+      @description = hash.delete :description
       
-      # if no content, try to use hash to initialize, delete in the process
-      unless content
-        self.bookmark_url = attributes.delete :bookmark_url
-        self.description = attributes.delete :description
-      else
-        # parse bookmark_url and description out of content
-        @bookmark_url = content[/\{bookmark:url=([^\}]+)\}/, 1]
-        @description = content[/\{bookmark.*\}([^\{]*)\{bookmark\}/, 1]
-      end
+      # initialize page
+      super(hash)
     end
     
-    def bookmark_url=(value)
-      @bookmark_url = value
-      
-      # update content with new bookmark_url
-      update_content
+    def [](attr)
+      case attr
+      when :bookmark_url: @bookmark_url
+      when :description: @description
+      else
+        super(attr)
+      end
     end
     
-    def description=(value)
-      @description = value
-
-      # update content with new description
-      update_content
+    def []=(attr, value)
+      case attr
+      when :bookmark_url: @bookmark_url = value
+      when :description: @description = value
+      else
+        super(attr, value)
+      end
     end
     
     def store
@@ -38,8 +37,24 @@ module Confluence
       super
     end
     
+    def to_hash
+      page_hash = super
+
+      if page_hash.key? "content"
+        page_hash["content"] << "\n" << bookmark_content
+      else
+        page_hash["content"] = bookmark_content
+      end
+      
+      page_hash
+    end
+    
     private
     
+    def bookmark_content
+      "{bookmark:url=#{@bookmark_url}}#{@description}{bookmark}"
+    end
+    
     def self.find_criteria(args)
       result = super(args) || begin
         if args.key? :space
@@ -50,9 +65,5 @@ module Confluence
       
       result
     end
-    
-    def update_content
-      self.content = "{bookmark:url=#{@bookmark_url}}#{@description}{bookmark}"
-    end
   end
 end

data/lib/confluence/page.rb

@@ -1,5 +1,25 @@
 module Confluence
   class Page < Record
+    class Details < Hash
+      attr_reader :label
+      
+      def initialize(label)
+        @label = label
+      end
+            
+      def to_s
+        # details macro
+        content = "{details:label=#{label}}\n"
+        
+        each_pair do |key, value|
+          content << "#{key}=#{value}\n"
+        end
+        
+        # end of details macro
+        content << "{details}"
+      end
+    end
+    
     extend Findable
     
     record_attr_accessor :id => :page_id
@@ -8,7 +28,21 @@ module Confluence
     record_attr_accessor :title, :creator, :modifier, :content
     record_attr_accessor :created, :modified, :version
     record_attr_accessor :url
+
+    def initialize(hash)
+      super(hash)
+
+      @details = []
+    end
+    
+    def details(label)
+      unless result = @details.find {|d| d.label == label}
+        @details << (result = Details.new(label))
+      end
             
+      result
+    end
+    
     def children(klass = self.class)
       children = client.getChildren(page_id)
       children.collect { |child| klass.find(:id => child["id"]) } if children
@@ -31,7 +65,7 @@ module Confluence
       end
       
       # reinitialize page after storing it
-      initialize(client.storePage(attributes))
+      initialize(client.storePage(self.to_hash))
       
       # return self
       self
@@ -41,8 +75,26 @@ module Confluence
       client.removePage(page_id)
     end
     
+    def to_hash
+      # record hash
+      record_hash = super
+      
+      # always include content in hash
+      record_hash['content'] ||= ''
+      
+      # prepend details sections before content
+      record_hash['content'].insert(0, details_content + "\n") if details_content
+      
+      # result
+      record_hash
+    end
+
     private
     
+    def details_content
+      @details.join("\n") unless @details.empty?
+    end
+    
     def self.find_all
       raise ArgumentError, "Cannot find all pages, find by id or title instead."
     end

data/lib/confluence/record.rb

@@ -44,12 +44,12 @@ module Confluence
       end
     end
 
+    # Returns the the Confluence API client.
+    #
     def client
       Record.client
     end
 
-    attr_accessor :attributes
-    
     # Initializes a new record.
     #
     # ==== Parameters
@@ -77,10 +77,14 @@ module Confluence
       self[:id]
     end
     
+    # Retrieves the labels of the record.
+    #
     def labels
       @labels ||= client.getLabelsById(record_id).collect {|label| label["name"]}
     end
     
+    # Sets the labels of the record.
+    #
     def labels=(value)
       removed_labels = labels - value
       added_labels = value - labels
@@ -90,5 +94,11 @@ module Confluence
       
       @labels = value
     end
+    
+    def to_hash
+      hash = Hash.new
+      @attributes.each { |key, value| hash[key.to_s] = value }
+      hash
+    end
   end
 end

data/spec/confluence/bookmark_spec.rb

@@ -1,4 +1,35 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
 describe Confluence::Bookmark do
+  it "should initialize bookmark_url and description from hash" do
+    bookmark = Confluence::Bookmark.new :bookmark_url => 'http://github.com/rgabo/confluencer', :description => 'Home sweet home'
+    
+    bookmark.bookmark_url.should == 'http://github.com/rgabo/confluencer'
+    bookmark.description.should == 'Home sweet home'
+  end
+  
+  it "should get and set bookmark_url and description using #[]" do
+    bookmark = Confluence::Bookmark.new :bookmark_url => 'http://github.com/rgabo/confluencer', :description => 'Home sweet home'
+
+    # bookmark_url and description should not be available as ordinary attributes in the hash
+    bookmark[:bookmark_url].should == 'http://github.com/rgabo/confluencer'
+    bookmark[:description].should == 'Home sweet home'
+    
+    bookmark[:bookmark_url] = 'http://github.com/rgabo'
+    bookmark[:description] = 'rgabo @ Github'
+    
+    bookmark[:bookmark_url].should == 'http://github.com/rgabo'
+    bookmark[:description].should == 'rgabo @ Github'
+
+    bookmark.bookmark_url.should == 'http://github.com/rgabo'
+    bookmark.description.should == 'rgabo @ Github'
+  end
+  
+  it "should not include bookmark_url and description in to_hash" do
+    bookmark = Confluence::Bookmark.new :bookmark_url => 'http://github.com/rgabo/confluencer', :description => 'Home sweet home', :title => "Page title"
+    
+    bookmark.to_hash.key?('bookmark_url').should be_false
+    bookmark.to_hash.key?('description').should be_false
+    bookmark.to_hash.key?('title').should be_true
+  end
 end

data/spec/confluence/page_spec.rb

@@ -74,19 +74,37 @@ describe Confluence::Page do
     page = store_test_page
     
     new_session do
-        # create test page with same title but updated content
-        updated_page = create_test_page "updated content"
+      # create test page with same title but updated content
+      updated_page = create_test_page "updated content"
+
+      updated_page.page_id.should be_nil
+      updated_page.title.should == page.title
+      updated_page.space.should == page.space
 
-        updated_page.page_id.should be_nil
-        updated_page.title.should == page.title
-        updated_page.space.should == page.space
+      # store page
+      updated_page.store
 
-        # store page
-        updated_page.store
+      # assert version
+      updated_page.version.should > page.version
+      updated_page.content.should == "updated content"
+    end      
+  end
+  
+  it "should keep metadata for the page" do
+    page = store_test_page
+    
+    # set :creator in {details:label=bender} to 'rgabo'
+    page.details(:confluencer)[:creator] = 'rgabo'
+  
+    page.details(:confluencer)[:creator].should == 'rgabo'
+  end
+  
+  it "should include metadata in content of the page" do
+    page = store_test_page
 
-        # assert version
-        updated_page.version.should > page.version
-        updated_page.content.should == "updated content"
-      end      
+    # set :creator in {details:label=bender} to 'rgabo'
+    page.details(:confluencer)[:creator] = 'rgabo'
+          
+    page.to_hash['content'].should include("{details:label=confluencer}\ncreator=rgabo\n{details}")
   end
 end

data/spec/confluence/record_spec.rb

@@ -15,9 +15,29 @@ describe Confluence::Record do
     record[:string].should == 'works'
   end
   
+  it "should return attribute values" do
+    record = Confluence::Record.new(:key => 'value', 'string_key' => 'string_value')
+    
+    record[:key].should == 'value'
+    record[:string_key].should == 'string_value' # attributes with string keys should be accessible with symbols
+  end
+  
+  it "should set attribute values" do
+    record = Confluence::Record.new
+    record[:key] = 'value'
+    
+    record[:key].should == 'value'
+  end
+  
   it "should return the id of the record" do
     record = Confluence::Record.new 'id' => '12345'
     
     record.record_id.should == '12345'
   end
+  
+  it "should return a string-keyed hash of its attributes" do
+    record = Confluence::Record.new :key => 'value'
+    
+    record.to_hash.should == {'key' => 'value'}
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 1
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Gabor Ratky
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-12 00:00:00 +02:00
+date: 2010-05-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,20 @@ dependencies:
         version: 1.3.0
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 7
+        version: 1.1.7
+  type: :runtime
+  version_requirements: *id002
 description: ActiveRecord-like classes to access Confluence through XMLRPC.
 email: rgabo@rgabostyle.com
 executables: []
@@ -39,13 +53,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README
 files: 
 - .document
 - .gitignore
 - .rvmrc
 - LICENSE
-- README.rdoc
+- README
 - Rakefile
 - VERSION
 - confluencer.gems