acts_as_formatted 0.0.1

data/lib/acts_as_formatted/acts_as_formatted.rb

@@ -0,0 +1,126 @@
+module ActsAsFormatted
+  mattr_accessor :default_options
+  self.default_options = {
+    :fields => :text,
+    :formatters => :simple
+  }
+  
+  module ActsMethods
+    def acts_as_formatted(options = {})
+      return if acts_as_formatted?
+      
+      initialize_format_configuration
+      set_format_configuration(options)
+      
+      define_format_hooks
+      extend_class_for_acts_as_formatted
+    end
+    
+    def acts_as_formatted?
+      self.included_modules.include?(ActsAsFormatted::InstanceMethods)
+    end
+  
+  private
+    def initialize_format_configuration
+      cattr_accessor :format_configuration
+      self.format_configuration = {}
+    end
+    
+    def set_format_configuration(options)
+      self.format_configuration[:fields] = normalized_format_configuration(options)
+    end
+    
+    def normalized_format_configuration(options)
+      config_options = ActsAsFormatted.default_options.merge(options)
+      fields = convert_fields_option_to_array(config_options[:fields])
+      [fields].flatten.inject({}) do |hash, field|
+        key, value = normalized_format_configuration_for(field, config_options)
+        hash[key] = value
+        hash
+      end
+    end
+    
+    def normalized_format_configuration_for(field, options)
+      field_name = field.is_a?(Hash) ? field.keys.first.to_sym : field.to_sym
+      field_options = field.is_a?(Hash) ? field[field_name] : (ActsAsFormatted.default_options.merge(options)).without(:fields)
+      formatters = field_options.is_a?(Hash) ? field_options[:formatters] : field_options
+      formatters ||= options[:formatters]
+      formatters = [formatters].flatten
+      
+      return field_name, {
+        :formatters => formatters,
+        :formatted_field => options[:formatted_field] || :"formatted_#{field_name}"
+      }
+    end
+    
+    def convert_fields_option_to_array(option)
+      if option.is_a?(Hash)
+        option.collect { |key, value| { key => value } }
+      else
+        option
+      end
+    end
+    
+    def define_format_hooks
+      self.before_save :update_formatted_content
+    end
+    
+    def extend_class_for_acts_as_formatted
+      self.extend         ActsAsFormatted::ClassMethods
+      self.send :include, ActsAsFormatted::InstanceMethods
+    end
+  end
+
+  module ClassMethods
+    def update_all_formatted_content!(timestamps = false)
+      timestamps ? update_all_formatted_content_with_timestamps! : update_all_formatted_content_without_timestamps!
+    end
+    
+  private
+  
+    def update_all_formatted_content_with_timestamps!
+      all.each do |instance|
+        instance.update_formatted_content!
+      end
+    end
+    
+    def update_all_formatted_content_without_timestamps!
+      without_timestamps do
+        update_all_formatted_content_with_timestamps!
+      end
+    end
+  end
+  
+  module InstanceMethods
+    def formatters_for(field_name)
+      @formatters ||= {}
+      @formatters[field_name] ||= begin
+        formatters = self.class.format_configuration[:fields][field_name][:formatters]
+        formatters.collect { |formatter| "#{formatter}_formatter".camelize.constantize.new }
+      end
+    end
+    
+    def reformat(field_name)
+      text = attributes[field_name.to_s]
+      formatters_for(field_name).each do |formatter|
+        text = formatter.format_text(text)
+      end unless text.nil?
+      text
+    end
+    
+    def update_formatted_content
+      self.class.format_configuration[:fields].each do |field_name, field_options|
+        send(:"#{field_options[:formatted_field]}=", reformat(field_name))
+      end
+    end
+    
+    def update_formatted_content!
+      update_formatted_content
+      save
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.extend(ActsAsFormatted::ActsMethods)
+  end
+end

data/lib/acts_as_formatted/formatters/link_formatter.rb

@@ -0,0 +1,9 @@
+class LinkFormatter
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+  include ActionView::Helpers::UrlHelper
+  
+  def format_text(text)
+    auto_link(text)
+  end
+end

data/lib/acts_as_formatted/formatters/noop_formatter.rb

@@ -0,0 +1,5 @@
+class NoopFormatter
+  def format_text(text)
+    text
+  end
+end

data/lib/acts_as_formatted/formatters/repair_html_formatter.rb

@@ -0,0 +1,7 @@
+require 'hpricot'
+
+class RepairHtmlFormatter
+  def format_text(text)
+    Hpricot(text).inner_html
+  end
+end

data/lib/acts_as_formatted/formatters/simple_formatter.rb

@@ -0,0 +1,8 @@
+class SimpleFormatter
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+  
+  def format_text(text)
+    simple_format(text)
+  end
+end

data/lib/acts_as_formatted/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def without(*keys)
+    inject({}) { |hash, pair| hash[pair.first] = pair.last unless keys.include?(pair.first); hash }
+  end
+end

data/lib/acts_as_formatted/timestamps.rb

@@ -0,0 +1,15 @@
+module ActiveRecord::Timestamps
+  def without_timestamps(&block)
+    rec_ts = ActiveRecord::Base.record_timestamps
+    applied_to = self.is_a?(Class) ? self : self.class
+    applied_to.record_timestamps = false
+    begin
+      yield
+    ensure
+      applied_to.record_timestamps = rec_ts
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, ActiveRecord::Timestamps)
+ActiveRecord::Base.send(:include, ActiveRecord::Timestamps)

data/lib/acts_as_formatted.rb

@@ -0,0 +1,10 @@
+# Include hook code here
+require 'acts_as_formatted/timestamps'
+require 'acts_as_formatted/acts_as_formatted'
+require 'acts_as_formatted/hash'
+
+Dir.glob(File.dirname(__FILE__) + '/acts_as_formatted//formatters/*.rb').sort.each do |formatter|
+  require formatter
+end
+
+ActiveRecord::Base.send :include, ActsAsFormatted

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_formatted
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- imedo GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-25 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: entwickler@imedo.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/acts_as_formatted/acts_as_formatted.rb
+- lib/acts_as_formatted/formatters/link_formatter.rb
+- lib/acts_as_formatted/formatters/noop_formatter.rb
+- lib/acts_as_formatted/formatters/repair_html_formatter.rb
+- lib/acts_as_formatted/formatters/simple_formatter.rb
+- lib/acts_as_formatted/hash.rb
+- lib/acts_as_formatted/timestamps.rb
+- lib/acts_as_formatted.rb
+has_rdoc: true
+homepage: http://www.imedo.de
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Save processed version of a text in the database.
+test_files: []
+