gollum_rails 0.0.2.8 → 0.0.5

data/gollum_rails.gemspec

@@ -1,57 +1,72 @@
-Gem::Specification.new do |s|
-  s.rubygems_version = '1.3.5'
-  s.name = 'gollum_rails'
-  s.version = '0.0.2.8'
-
-  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')
-  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 = 'Florian Kasper'
-  s.email = 'nirnanaaa@khnetworks.com'
-  s.homepage = 'https://github.com/nirnanaaa/gollum_rails'
-  s.platform = Gem::Platform::RUBY
-  s.required_ruby_version = '>=1.8.7'
-  
-  # = MANIFEST =
-  s.files = %w[
-    Gemfile
-    Gemfile.lock
-    HISTORY.md
-    LICENSE.md
-    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/hash.rb
-    lib/gollum_rails/messages.yml
-    lib/gollum_rails/page.rb
-    lib/gollum_rails/validations.rb
-    lib/gollum_rails/versions.rb
-    lib/gollum_rails/wiki.rb
-  ]
-  # = MANIFEST =
-
-
-  s.require_paths = %w[lib]
-  s.has_rdoc = true
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
-end  
+Gem::Specification.new do |s|
+  s.rubygems_version = '>= 1.3.5'
+  
+  s.name = 'gollum_rails'
+  s.rubyforge_project = s.name
+
+  s.version = '0.0.5'
+
+  s.summary = 'Combines the benefits from Gollum and Rails'
+  s.description= 'Use all the benefits from Rails and combine them with the awesome Gollum wiki'
+  #File.read(File.join(File.dirname(__FILE__), 'README.md'))
+
+  s.add_dependency 'activemodel', '~> 3.2.13'
+  s.add_dependency 'gollum-lib', '~> 0.0.1'
+  #s.add_dependency 'grit', '~> 2.5.0'
+  s.add_dependency 'builder', '~> 3.0.0'
+  s.add_dependency 'rack', '~> 1.4.5'
+
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+  s.add_development_dependency 'rails', '~> 3.2.13'
+  s.add_development_dependency 'rr', '~> 1.0.4' 
+  s.add_development_dependency 'rails', '~> 3.2.13'
+
+  s.author = 'Florian Kasper'
+  s.email = 'mosny@zyg.li'
+  s.homepage = 'http://gollum.zyg.li'
+  s.license = 'AGPL'
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>=1.9.3'
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    HISTORY.md
+    LICENSE
+    README.md
+    Rakefile
+    examples/rails/initializer.rb
+    gollum_rails.gemspec
+    lib/gollum_rails.rb
+    lib/gollum_rails/adapters/activemodel.rb
+    lib/gollum_rails/adapters/activemodel/boolean.rb
+    lib/gollum_rails/adapters/activemodel/callback.rb
+    lib/gollum_rails/adapters/activemodel/error.rb
+    lib/gollum_rails/adapters/activemodel/naming.rb
+    lib/gollum_rails/adapters/activemodel/validation.rb
+    lib/gollum_rails/adapters/gollum.rb
+    lib/gollum_rails/adapters/gollum/.gitkeep
+    lib/gollum_rails/adapters/gollum/committer.rb
+    lib/gollum_rails/adapters/gollum/error.rb
+    lib/gollum_rails/adapters/gollum/page.rb
+    lib/gollum_rails/adapters/gollum/wiki.rb
+    lib/gollum_rails/initializer.rb
+    lib/gollum_rails/modules/hash.rb
+    lib/gollum_rails/modules/loader.rb
+    lib/gollum_rails/page.rb
+    lib/gollum_rails/setup.rb
+  ]
+  # = MANIFEST =
+
+
+  s.require_paths = %w[lib]
+  s.post_install_message = "Important: \n\n" \
+  "**********************************************\n\n" \
+  "To use the 'autoinitializer' just run the following command:\n\n"\
+  "\t\trails g gollum_rails:install\n\n"\
+  "To generate a new Page model just run:\n\n"\
+  "\t\rails g gollum_rails:model MODEL_NAME"\
+  "**********************************************"
+end
+

data/lib/gollum_rails.rb

@@ -1,18 +1,35 @@
-# ~*~ 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 GollumRails
-  VERSION = '0.0.2.8'
-
-end
+require 'rubygems'
+require 'gollum-lib'
+
+# GollumRails is a RubyGem for extending Rails and the Gollum wiki powered by github
+# It has the ability to combine the benefits from a git powered wiki with Rails.
+#
+# Example solutions:
+#   * Gollum Wiki pages - Devise authentication - GollumRails connector - Haml layouting
+#   * Gollum Wiki pages - Ember.js - Handlebars layout - Rails REST API
+#   * ...
+#
+module GollumRails
+  
+  # GollumRails version string
+  VERSION = '0.0.5'
+  
+  # Simplified error
+  class Error < StandardError; end
+
+  # For use with internal gollumGem exceptions
+  # 
+  class GollumInternalError < Error
+  
+  end
+end
+
+
+require File.expand_path '../gollum_rails/adapters/activemodel', __FILE__
+require File.expand_path '../gollum_rails/adapters/gollum', __FILE__
+require File.expand_path '../gollum_rails/setup', __FILE__
+require File.expand_path '../gollum_rails/page', __FILE__
+# load extensions
+require File.expand_path '../gollum_rails/modules/loader', __FILE__
+
+

data/lib/gollum_rails/adapters/activemodel.rb

@@ -0,0 +1,46 @@
+require 'active_model'
+module GollumRails
+
+  # Adapter class. To be documented
+  module Adapters
+    
+    # ActiveModel improvements and own connectors
+    #
+    # including:
+    #   * validation
+    #   * callbacks
+    #   * naming
+    #   * error handling
+    # 
+    # The following files are involved:
+    #   * boolean.rb -> Boolean features for validation
+    #   * callback.rb -> Callback functionality
+    #   * naming.rb -> Conversion and Naming
+    #   * error.rb -> Active Model error handling
+    #   * validation.rb -> Object validation
+    #
+    # Released under the AGPL License. For further information see the LICENSE file distributed
+    # with this package.
+    #
+    # TODO:
+    #   * a lot of testing
+    #   * implementing the rest of the error class
+    #   * deleting the model template out
+    #   * move into own gem
+    #
+    # FIXME:
+    #   none a.t.m.
+    #
+    module ActiveModel
+
+      # connector version
+      VERSION="0.0.4"
+    end
+  end
+end
+
+require File.expand_path '../activemodel/boolean', __FILE__
+require File.expand_path '../activemodel/callback', __FILE__
+require File.expand_path '../activemodel/naming', __FILE__
+require File.expand_path '../activemodel/error', __FILE__
+require File.expand_path '../activemodel/validation', __FILE__

data/lib/gollum_rails/adapters/activemodel/boolean.rb

@@ -0,0 +1,15 @@
+module GollumRails
+  module Adapters
+    module ActiveModel
+
+      # Own implemented Boolean method for validating
+      module Boolean; end
+
+      # inherit
+      class ::TrueClass; include Boolean; end
+
+      # inherit
+      class ::FalseClass; include Boolean; end
+    end
+  end
+end

data/lib/gollum_rails/adapters/activemodel/callback.rb

@@ -0,0 +1,61 @@
+module GollumRails
+  module Adapters
+    module ActiveModel
+      
+      # Callback handling class
+      class Callback
+        extend ::ActiveModel::Callbacks
+        
+        define_model_callbacks :create, :only => [:after, :before]
+        define_model_callbacks :update, :only => [:after, :before]
+        define_model_callbacks :save, :only => [:after, :before]
+        define_model_callbacks :delete, :only => [:after, :before]
+        define_model_callbacks :find, :only => [:after, :before]
+
+        before_create :before_create
+        before_update :before_update
+        before_save :before_save
+        before_delete :before_delete
+        before_find :before_find
+
+        after_create :after_create
+        after_update :after_update
+        after_save :after_save
+        after_delete :after_delete
+        after_find :after_find
+
+        # Before create action
+        def before_create; end
+        
+        # Before update action
+        def before_update; end
+
+        # Before save action
+        def before_save; end
+
+        # Before delete action
+        def before_delete; end
+
+        # Before find action
+        def before_find; end
+
+        # After create action
+        def after_create; end
+
+        # After update action
+        def after_update; end
+
+        # After save action
+        def after_save; end
+
+        # After delete action
+        def after_delete; end
+
+        # After find action
+        def after_find; end
+
+      end
+
+    end
+  end
+end

data/lib/gollum_rails/adapters/activemodel/error.rb

@@ -0,0 +1,27 @@
+module GollumRails
+  module Adapters
+    module ActiveModel
+
+      # Error handling class, with several exception types and debug / info messages
+      class Error < ::GollumRails::GollumInternalError
+        extend ::ActiveModel::Naming
+        
+        ######
+        public
+        ######
+
+        # Gets/Sets the Error
+        attr_reader :errors
+
+        # Initializes a new Exception
+        # 
+        def initialize(name, message = nil, priority = :crit)
+          super("Error thrown: #{name},\n\n #{(message)}")
+        end
+
+
+      end
+
+    end
+  end
+end

data/lib/gollum_rails/adapters/activemodel/naming.rb

@@ -0,0 +1,42 @@
+
+module GollumRails
+  module Adapters
+    module ActiveModel
+
+      # Naming class for all Classes, extending the AdtiveModel::Naming module
+      #
+      # provides base functionality like filenames, classnames, variable-, instancenames
+      module Naming
+        
+        # Outputs the currents class name
+        #
+        # Returns a String
+        def class_name
+          self.class.name
+        end
+
+        # Gets the pluralized filename for an object
+        #
+        # Returns a String
+        def plural_filename_for_class(name)
+         return ::ActiveModel::Naming.plural name if name.model_name
+         return nil
+        end
+
+        # Gets the singularized filename for an object
+        #
+        # Returns a String
+        def singular_filename_for_class(name)
+         return ::ActiveModel::Naming.singular name if name.model_name
+         return nil
+        end
+      
+        # dummy namespace class
+        class NameSpace
+          extend ::ActiveModel::Naming
+        end
+      end
+
+    end
+  end
+end

data/lib/gollum_rails/adapters/activemodel/validation.rb

@@ -0,0 +1,188 @@
+module GollumRails
+  module Adapters
+    module ActiveModel
+
+      # General Validation Class including validations
+      class Validation
+        include ::ActiveModel::Validations
+        
+        #########
+        protected
+        #########
+
+        # Sets the variable, used to validate
+        attr_writer :variable
+        
+        # Sets the Filter
+        attr_accessor :filter
+
+        # Sets all instance errors to this variable
+        attr_writer :error
+
+        ######
+        public
+        ######
+        
+        # Gets the variable, used to validate
+        attr_reader :variable
+
+        # Gets the error messages
+        attr_reader :error
+
+        # Checks for errors and returns either true or false
+        #
+        # Examples:
+        #   @validator.valid?
+        #   # => true
+        #   or 
+        #   # => false
+        #
+        def valid?(errors = {})
+          super
+          return true if self.errors.messages == Hash.new and errors == Hash.new
+          self.error = errors
+          return false
+        end
+
+        # Initializes the Validator
+        # You can pass in a block with validators, which will be used to validate given attributes
+        # 
+        # Blocks look like:
+        #
+        # "#{variable} : type=String : max=200"
+        # "#{textvariable} : type=Hash"
+        # "#{integer} : min=100 : max=200"
+        #
+        # They have always the following format:
+        #   
+        #   KEY=VALUE or KEY!VALUE
+        #
+        #   key=value explains itself. It validates the variable <b>variable</b> with the given <b>key<b> validator
+        #   and checks if it matches the given <b>value</b>
+        #
+        #   key!value is the negociation of key=value
+        #
+        #
+        # The following keys are currently available:
+        #   * type
+        #   * max
+        #   * present
+        #   * min
+        #
+        # Following:
+        #   * contribute yourself
+        #
+        # Usage:
+        #   variable = "This is a simple test"
+        #   validator = GollumRails::Adapters::ActiveModel::Validation.new 
+        #   validator.validate!  do |a|
+        #     a.validate(variable, "type=String,max=100,present=true")
+        #   end 
+        #   validator.valid?
+        #   # => true
+        #
+        # Params:
+        #   block - Block to use
+        #
+        # Returns:
+        def validate(&block)
+          bla = block.call(self)
+        end
+        
+
+        # Aliasing test method
+        alias_method :validate!, :test
+
+        # Tests given variable for conditions
+        #
+        # Params:
+        #   variable - variable to validate
+        #   statement - validation statement, seperated by coma
+        #
+        #
+        def test(variable,statement)
+          validation = {}
+          if statement.include? ',' and statement.include? '='
+            statement.split(',').each{|equalized|
+             key,value = split_equalized_string equalized
+             validation[key.to_s.downcase.to_sym] = value if not key.nil?
+            }
+          elsif statement.include? '='
+            key,value = split_equalized_string statement
+            validation[key.to_s.downcase.to_sym] = value if not key.nil? 
+          else
+            raise Error, 'Syntax error! '
+          end
+          self.instance_variable_set("@variable", variable)
+
+          validation.each_with_index do |k|
+            if k.first.to_s.match /^type$/i
+              code = <<-END
+                self.singleton_class.class_exec do attr_accessor :type end
+                self.instance_variable_set("@type", "#{k[1]}")
+                validates_with ValidateType, :fields => [:variable]
+              END
+            elsif k.first.to_s.match /^(present|presence|pres)$/i
+              code = <<-END
+                validates_presence_of :variable
+              END
+            elsif k.first.to_s.match /^(min|max)$/i
+              code = <<-END
+                validates_length_of :variable, :#{k.first.to_s}imum => #{k[1].to_i}
+              END
+            else
+              puts <<-END
+              WARNING: no validator matches! This will cause an Error in the next release
+              END
+              next
+            end
+            self.instance_eval(code) if code
+          end
+          errors = self.errors.messages
+          self.errors.instance_variable_set("@messages", {})
+          valid? errors
+        end
+  
+        #######
+        private
+        #######
+        
+        # Splits given by "="
+        #
+        # string - String to be split
+        #
+        # Returns splitted string or raise an error
+        def split_equalized_string(string)
+          if string.match /\w+\=(\w+|\d+)/i
+            return string.split(/\=/,2)
+          else
+            raise Error, <<-END 
+              Syntax error in given String #{string}. Equal sign is missing
+            END
+          end
+
+        end
+      end
+
+
+      # Validation helper for type:
+      #
+      # <b>Type</b>
+      class ValidateType < ::ActiveModel::Validator
+
+        # Validate given Data with given validation object
+        #
+        # sets error or returns true
+        def validate(record)
+          if record.type.match(/^\w+$/i)
+            name = eval "#{record.type.to_s}"
+            return true if record.variable.is_a? name
+            record.errors.add :type, "not a kind of given class #{record.type}"
+          else
+            record.errors.add :type ,"invalid input detected"
+          end
+        end
+      end
+    end
+  end
+end