gollum_rails 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'rake', '~> 10.0.2'

data/gollum_rails.gemspec

@@ -0,0 +1,44 @@
+Gem::Specification.new do |s|
+   s.name = 'gollum_rails'
+   s.version = '0.0.1'
+   
+   s.summary = 'Combines Gollum wiki with Rails'
+   s.description= File.read(File.join(File.dirname(__FILE__), 'README.md'))
+   
+   s.add_dependency('activemodel', '~> 3.2.11')
+   s.add_dependency('gollum', '~> 2.4.11')
+   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')
+   s.add_development_dependency('rake', '~> 10.0.2')
+   s.add_development_dependency('rails', '~> 3.2.11')
+   
+   s.author = 'nirnanaaa'
+   s.email = 'nirnanaaa@khnetworks.com'
+   s.homepage = 'https://github.com/nirnanaaa/gollum_rails'
+   s.platform = Gem::Platform::RUBY
+   s.required_ruby_version = '>=1.9'
+   s.files = %w[
+     Gemfile
+     HISTORY.md
+     gollum_rails.gemspec
+     LICENSE.md
+     README.md
+     lib/gollum_rails.rb
+     lib/gollum/rails/dependency_injector.rb
+     lib/gollum/rails/page.rb
+     lib/gollum/rails/validations.rb
+     lib/gollum/rails/wiki.rb
+     lib/gollum/rails/version.rb
+     lib/gollum/rails/gollum_rails.rb
+     lib/gollum/rails/engine.rb
+     lib/gollum/rails/config.rb
+     lib/gollum/rails/messages.yml
+   ]
+   s.require_paths = %w[lib]
+   s.has_rdoc = false
+   s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/gollum/rails/config.rb

@@ -0,0 +1,38 @@
+require 'yaml'
+
+module Gollum
+  module Rails
+    class Config
+      attr_reader :config
+      def self.read_config
+        @config = self.open_config
+        @config
+      end
+      def self.config_location
+      end
+
+      def self.lang_from_rails
+      end
+
+      def self.settings_from_rails
+        Rails.settings
+      end
+
+      def self.rails_root
+        Rails.root
+      end
+
+      def self.rails_config_dir
+      end
+      
+      #######
+      private
+      #######
+      #gives a hardcoded configuration file
+      def self.open_config
+        YAML.load_file(::File.join(::File.dirname(__FILE__), 'messages.yml'))
+      end
+
+    end
+  end
+end

data/lib/gollum/rails/dependency_injector.rb

@@ -0,0 +1,30 @@
+module Gollum
+  module Rails
+    ## simple DI component
+    class DependencyInjector
+
+      attr_accessor :storage
+      
+      #initializes the :storage with a new Hash
+      def self.initialize
+        @storage = Hash.new
+      end
+      
+      #sets a storage Hash
+      def self.set(name, value)
+        if !@storage.is_a?(Hash)
+          self.initialize
+        end  
+        @storage[name] = value
+      end
+
+      # gets a storage
+      def self.get(name)
+        if !@storage.is_a?(Hash)
+          self.initialize
+        end
+        @storage[name]
+      end
+    end
+  end
+end

data/lib/gollum/rails/engine.rb

@@ -0,0 +1,13 @@
+require 'rails'
+require 'gollum/rails/config'
+  
+module Gollum
+  module Rails
+    class Engine < ::Rails::Engine
+      #initialize "gollum_rails.load_app" do |app|
+      ##   Gollum::Rails::Config::rails = app
+     # end
+    end
+  end
+end
+

data/lib/gollum/rails/gollum_rails.rb

@@ -0,0 +1,7 @@
+require "gollum/rails/engine"
+require "gollum/rails/version"
+require 'gollum/rails/config'
+require "gollum/rails/dependency_injector"
+require "gollum/rails/wiki"
+require "gollum/rails/page"
+require 'gollum/rails/validations'

data/lib/gollum/rails/messages.yml

@@ -0,0 +1,2 @@
+a:
+  file: is

data/lib/gollum/rails/page.rb

@@ -0,0 +1,240 @@
+# ~*~ encoding: utf-8 ~*~
+module Gollum
+  module Rails
+    class Page
+      include ActiveModel::Conversion
+      extend ActiveModel::Naming
+
+      #the filename
+      attr_accessor :name
+
+      # text content
+      attr_accessor :content
+
+      # file formatting type
+      # possible:
+      #  - :asciidoc
+      #  - :creole
+      #  - :markdown
+      #  - :org
+      #  - :pod
+      #  - :rdoc
+      #  - :rst
+      #  - :tex
+      #  - :wiki
+      attr_accessor :format
+
+      # the commit Hash
+      attr_accessor :commit
+
+      # WHAT?!
+      attr_accessor :options
+
+      # a boolean variable that holds the status of save() and update()
+      attr_reader :persisted
+
+      # holds the error messages
+      attr_reader :error
+
+      # holds an instance of Gollum::Wiki
+      attr_reader :wiki
+      # attributes needs to be a hash
+      # example:
+      #   Gollum::Rails::Page.new({name: '', content: '', format: '', commit: {}})
+      #
+      #
+      # explanation:
+      # name must be a string.
+      # content should be a text/String
+      # format must be eighter :markdown, :latex, :rdoc, ...
+      # commit must be a hash for example:
+      #   commit = {
+      #      message: 'page created',
+      #      name: 'Florian Kasper',
+      #      email: 'nirnanaaa@khnetworks.com'
+      #   }
+      def initialize(attributes = {}, options = {})
+        wiki = DependencyInjector.get('wiki')
+        if wiki && wiki.is_a?(Wiki)
+          @wiki = wiki
+        end
+        if !Validations.is_boolean?(@persisted)
+          @persisted = false
+        end
+        if !@error
+          @error = nil
+        end
+        attributes.each do |name, value|
+          send("#{name}=", value)
+        end
+
+      end
+
+      ## checks if @wiki.wiki is an instance of Gollum::Wiki
+      def wikiLoaded?
+        @wiki.wiki.is_a?(Gollum::Wiki)
+      end
+
+      ## Error String content brought by the functions in this class
+      def get_error_message
+        @error
+      end
+
+      # Some "ActiveRecord" like things e.g. .save .valid? .find .find_by_* .where and so on
+      def save
+        if valid?
+          begin
+            @wiki.wiki.write_page(@name, @format, @content, @commit)
+            @persisted = true
+          rescue Gollum::DuplicatePageError => e
+            @error = e
+            return false
+          end
+        end
+        return true
+      end
+
+      # Updates an existing page
+      # usage:
+      #
+      #
+      # wiki = Gollum::Rails::Wiki.new(PATH)
+      #
+      # page = Gollum::Rails::Page.new
+      # cnt = page.find(PAGENAME)
+      #
+      # commit = {
+      #   :message => "production test update",
+      #   :name => 'Florian Kasper',
+      #   :email => 'nirnanaaa@khnetworks.com'
+      # }
+      # update = page.update("content", commit)
+
+      def update(content, commit, name=nil, format=nil)
+        if !name.nil?
+          @name = name
+        end
+        if !format.nil?
+          @format = format
+        end
+        if commit.nil? || content.nil?
+          @error = "commit must be given"
+          return false
+        end
+        return @wiki.wiki.update_page(@page, @name, @format, content, commit)
+      end
+      
+      # Deletes page fetched by find()
+      def delete(commit)
+        if commit.nil?
+          @error = "commit must be given"
+          return false
+        end
+        return @wiki.wiki.delete_page(@page, commit)
+      end
+      # if a page is loaded wraps Gollum::Page.raw_data
+      def raw_data
+        if @page
+          @page.raw_data
+        else
+          @error = "no page fetched"
+          return false  
+        end
+      end
+      
+      # if a page is loaded wraps Gollum::Page.formatted_data
+      def formatted_data
+        if @page
+          @page.formatted_data
+        else
+          @error = "no page fetched"
+          return false  
+        end
+      end
+      
+      # Active Record like
+      # Page.version.first.id
+      # Page.version.first.authored_data
+      #
+      #
+      # see Active Model documentation
+      def version
+        if @page
+          @page.versions
+        else
+          @error = "no page fetched"
+          return false  
+        end
+      end
+
+
+
+      #
+      # Validates the Class variables
+      # default:
+      #  - name must be set
+      #  - content can be NIL || " "
+      #  - committer must be set
+      # format must be set
+      def valid?
+        if !@name || @name.nil?
+          return false
+        end
+        if !@commit || !@commit.is_a?(Hash)
+          return false
+        end
+        if !@format
+          return false
+        end
+        return true
+
+      end
+
+      #gets an Instance of Gollum::Wiki fetched by find() method
+      attr_reader :page
+
+      #finds a wiki page
+      def find(name = nil)
+        if !name.nil?
+          page = @wiki.wiki.page(name)
+          if page.nil?
+            @error = "The given page was not found"
+            return nil
+          end
+
+          #need a better solution thats fu***** bull*****
+          @page = page
+          @name = page.name
+          @format = page.format
+
+          return page
+        else
+          return nil
+        end
+      end
+
+      def persisted?
+        @persisted
+      end
+
+      # Static into non static converter
+      def self.method_missing(name, *args)
+        klass = self.new
+        return klass.send(name, args)
+      end
+
+      #  def method_missing(name, *args)
+      #      meth = name.to_s.index("find_by_")
+      #      if meth.nil?
+      #        @error = "method not found"
+      #        raise RuntimeError
+      #      end
+      #      finder = name[8 .. name.length]
+      #      if finder == "name"
+      # find(args)
+      #      end
+      #  end
+
+    end
+  end
+end

data/lib/gollum/rails/validations.rb

@@ -0,0 +1,10 @@
+module Gollum
+  module Rails
+    class Validations
+      include ActiveModel::Validations
+      def self.is_boolean?(variable)
+        variable.is_a?(TrueClass) || variable.is_a?(FalseClass) 
+      end
+    end
+  end
+end

data/lib/gollum/rails/version.rb

@@ -0,0 +1,5 @@
+module Gollum
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/lib/gollum/rails/wiki.rb

@@ -0,0 +1,34 @@
+module Gollum
+  module Rails
+    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

data/lib/gollum_rails.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'gollum'
+
+module Gollum
+  module Rails
+    require 'gollum/rails/engine' if defined?(Rails)
+  end
+end
+
+require 'gollum/rails/gollum_rails' if defined?(Rails)

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: gollum_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- nirnanaaa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: gollum
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.11
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: org-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+description: ''
+email: nirnanaaa@khnetworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- HISTORY.md
+- gollum_rails.gemspec
+- LICENSE.md
+- README.md
+- lib/gollum_rails.rb
+- lib/gollum/rails/dependency_injector.rb
+- lib/gollum/rails/page.rb
+- lib/gollum/rails/validations.rb
+- lib/gollum/rails/wiki.rb
+- lib/gollum/rails/version.rb
+- lib/gollum/rails/gollum_rails.rb
+- lib/gollum/rails/engine.rb
+- lib/gollum/rails/config.rb
+- lib/gollum/rails/messages.yml
+homepage: https://github.com/nirnanaaa/gollum_rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Combines Gollum wiki with Rails
+test_files: []