gollum_rails 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,102 @@
+Gollum for Rails
+================
+
+Gollum for Rails combines the benefits from gollum with the flexibility of Rails.
+
+It improves the lightweight "gollum" experience which is quite awesome.
+
+You can:
+
+* Define your own views
+* Use your Rails layouts
+* Embed it without mounting something in your Rack app
+* Use own preprocession e.g. Sidekiq for Async Syntax highlightning
+* Use user Authentication e.g. Devise or Authlogic
+
+## SYSTEM REQUIREMENTS
+- Python 2.5+ (2.7.3 recommended)
+- Ruby 1.8.7+ (1.9.3 recommended)
+- Unix like operating system (OS X, Ubuntu, Debian, and more)
+- Will not work on Windows (see [gollum](https://github.com/github/gollum/blob/master/README.md#system-requirements))
+
+## INSTALLATION
+
+Put
+
+	gem 'gollum_rails'
+
+
+in your `Gemfile`
+
+Then just run the [Bundler](http://gembundler.com/)
+
+	$ bundle install
+	
+If you want you can add an initializer into e.g. `config/initializers/gollum_rails.rb`
+
+	Gollum::Rails::Wiki.new(<location>)
+
+Now your gollum is ready for use
+
+If you want you can add a model the same way as normal `ActiveRecord` / `ActiveModel`
+
+	class Page < Gollum::Rails::Page
+
+	end
+	
+## Validating
+
+Works like `ActiveRecord` / `ActiveModel` validation
+
+some examples:
+
+
+## API
+
+
+## TODO
+* List all pages
+* Search pages
+* embed gollum :markdown editor
+
+## DEVELOPER
+
+Very cool. Just fork this repository and send  pull requests ;)
+
+### QUICK START
+
+Clone the repository:
+
+	$ git clone git://github.com/nirnanaaa/gollum_rails.git
+	
+Run the [Bundler](http://gembundler.com/):
+
+	$ bundle install
+	
+
+### TESTING
+
+First use the Quick Start to install all dependencys.
+All tests are stored under the `test/` directory.
+
+First you must create a `wiki` repository.
+
+	$ git init test/wiki
+	
+To run tests just use the `rake` command:
+
+	$ bundle exec rake
+
+BE CAREFUL! THE FIRST TEST WILL FAIL BECAUSE THE NECESSARY STATIC FILES ARE NOT EXISTING
+
+
+## EXAMPLE
+## LICENSE
+Copyright � 2013 Florian Kasper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the �Software�), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED �AS IS�, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+

data/gollum_rails.gemspec

@@ -1,9 +1,10 @@
 Gem::Specification.new do |s|
    s.name = 'gollum_rails'
-   s.version = '0.0.1'
+   s.version = '0.0.2'
    
-   s.summary = 'Combines Gollum wiki with Rails'
-   s.description= File.read(File.join(File.dirname(__FILE__), 'README.md'))
+   s.summary = 'Combines the benefits from Gollum with Rails'
+   s.description= 'use templating, authentication and so on'
+   #File.read(File.join(File.dirname(__FILE__), 'README.md'))
    
    s.add_dependency('activemodel', '~> 3.2.11')
    s.add_dependency('gollum', '~> 2.4.11')
@@ -37,6 +38,7 @@ Gem::Specification.new do |s|
      lib/gollum/rails/engine.rb
      lib/gollum/rails/config.rb
      lib/gollum/rails/messages.yml
+     lib/gollum/rails/hash.rb
    ]
    s.require_paths = %w[lib]
    s.has_rdoc = false

data/lib/gollum/rails/config.rb

@@ -5,8 +5,8 @@ module Gollum
     class Config
       attr_reader :config
       def self.read_config
-        @config = self.open_config
-        @config
+        config = self.open_config
+        DependencyInjector.set('config', config)
       end
       def self.config_location
       end

data/lib/gollum/rails/hash.rb

@@ -0,0 +1,7 @@
+class ::Hash
+  def method_missing(name)
+    return self[name] if key? name
+    self.each { |k,v| return v if k.to_s.to_sym == name }
+    super.method_missing name
+  end
+end

data/lib/gollum/rails/messages.yml

@@ -1,2 +1,7 @@
-a:
-  file: is
+messages:
+  name_not_set_or_nil: The name is not set or is NIL
+  commit_not_empty_and_content_not_empty: The commit must be set and also the content
+  commit_must_be_given: Commit must not be empty or nil
+  no_page_fetched: No page was fetched
+  no_page_found: The page was not found
+  format_not_set: The format was not set

data/lib/gollum/rails/page.rb

@@ -1,8 +1,10 @@
 # ~*~ encoding: utf-8 ~*~
+require "gollum/rails/hash"
 module Gollum
   module Rails
-    class Page
+    class Page 
       include ActiveModel::Conversion
+      include ActiveModel::Validations
       extend ActiveModel::Naming
 
       #the filename
@@ -27,7 +29,7 @@ module Gollum
       # the commit Hash
       attr_accessor :commit
 
-      # WHAT?!
+      # Holds a ::Hash of config options
       attr_accessor :options
 
       # a boolean variable that holds the status of save() and update()
@@ -38,6 +40,10 @@ module Gollum
 
       # holds an instance of Gollum::Wiki
       attr_reader :wiki
+      
+      # class names
+      attr_reader :class
+      
       # attributes needs to be a hash
       # example:
       #   Gollum::Rails::Page.new({name: '', content: '', format: '', commit: {}})
@@ -55,8 +61,16 @@ module Gollum
       #   }
       def initialize(attributes = {}, options = {})
         wiki = DependencyInjector.get('wiki')
+        config = DependencyInjector.get('config')
         if wiki && wiki.is_a?(Wiki)
           @wiki = wiki
+        else
+          raise RuntimeError
+        end
+        if config && config.is_a?(Hash)
+          @options = config
+        else
+          raise RuntimeError  
         end
         if !Validations.is_boolean?(@persisted)
           @persisted = false
@@ -118,7 +132,7 @@ module Gollum
           @format = format
         end
         if commit.nil? || content.nil?
-          @error = "commit must be given"
+          @error = @options.messages.commit_not_empty_and_content_not_empty
           return false
         end
         return @wiki.wiki.update_page(@page, @name, @format, content, commit)
@@ -127,7 +141,7 @@ module Gollum
       # Deletes page fetched by find()
       def delete(commit)
         if commit.nil?
-          @error = "commit must be given"
+          @error = @options.messages.commit_must_be_given
           return false
         end
         return @wiki.wiki.delete_page(@page, commit)
@@ -137,7 +151,7 @@ module Gollum
         if @page
           @page.raw_data
         else
-          @error = "no page fetched"
+          @error = @options.messages.no_page_fetched
           return false  
         end
       end
@@ -147,7 +161,7 @@ module Gollum
         if @page
           @page.formatted_data
         else
-          @error = "no page fetched"
+          @error = @options.messages.no_page_fetched
           return false  
         end
       end
@@ -162,7 +176,7 @@ module Gollum
         if @page
           @page.versions
         else
-          @error = "no page fetched"
+          @error = @options.messages.no_page_fetched
           return false  
         end
       end
@@ -178,16 +192,21 @@ module Gollum
       # format must be set
       def valid?
         if !@name || @name.nil?
+          @error = @options.messages.name_not_set_or_nil
           return false
         end
         if !@commit || !@commit.is_a?(Hash)
+          @error = @options.messages.commit_must_be_given
           return false
         end
         if !@format
+          @error = @options.messages.format_not_set
           return false
         end
+        
+        super
+        
         return true
-
       end
 
       #gets an Instance of Gollum::Wiki fetched by find() method
@@ -198,7 +217,7 @@ module Gollum
         if !name.nil?
           page = @wiki.wiki.page(name)
           if page.nil?
-            @error = "The given page was not found"
+            @error = @options.messages.no_page_found
             return nil
           end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-26 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -171,7 +171,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.11
-description: ''
+description: use templating, authentication and so on
 email: nirnanaaa@khnetworks.com
 executables: []
 extensions: []
@@ -192,6 +192,7 @@ files:
 - lib/gollum/rails/engine.rb
 - lib/gollum/rails/config.rb
 - lib/gollum/rails/messages.yml
+- lib/gollum/rails/hash.rb
 homepage: https://github.com/nirnanaaa/gollum_rails
 licenses: []
 post_install_message: 
@@ -215,5 +216,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Combines Gollum wiki with Rails
+summary: Combines the benefits from Gollum with Rails
 test_files: []