myobie-turbine-core 0.4.0 → 0.5.1

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 4
-:patch: 0
+:minor: 5
+:patch: 1

data/lib/turbine-core/post_type.rb

@@ -1,32 +1,35 @@
 require 'rdiscount' # markdown
 require 'nokogiri'
 require 'uuidtools'
+require 'haml'
 
 class PostType
   extend ClassLevelInheritableAttributes
   include Extlib::Hook
   
   DEFAULT_FIELDS = [:published_at, :status, :slug, :trackbacks, :type, :tags]
-  NON_EDITABLE_FIELDS = [:trackbacks, :type, :published_at, :status] # don't show up in to_s
+  NON_EDITABLE_FIELDS = [:trackbacks, :type, :published_at]
+  
   
   # vars to inherit down
   cattr_inheritable :fields_list, :allowed_fields_list, :required_fields_list, :primary_field, :heading_field, 
-                    :specials_blocks, :defaults_blocks, :only_declared_fields, :always_use_uuid,
-                    :truncate_slugs, :markdown_fields
+                    :specials_blocks, :defaults_blocks, :string_for_blocks, :only_declared_fields, :always_use_uuid,
+                    :truncate_slugs, :markdown_fields, :html_block
   
   # defaults for class instance inheritable vars
   @fields_list = []
-  @allowed_fields_list = []
+  @allowed_fields_list = DEFAULT_FIELDS
   @required_fields_list = []
   @primary_field = nil
   @heading_field = nil
   @specials_blocks = {}
   @defaults_blocks = {}
+  @string_for_blocks = {}
   @only_declared_fields = true
   @always_use_uuid = false
   @truncate_slugs = true
   @markdown_fields = []
-  
+  @html_block = nil
   
   ### cattr_accessor
   @@preferred_order = []
@@ -39,10 +42,31 @@ class PostType
   end
   ### cattr_accessor
   
+  ### Defaults
+  after_class_method :inherited do |all_children, klass|
+    klass.string_for :tags do |tags_array|
+      tags_array.join(', ')
+    end
+    
+    klass.special :tags do |tags_string|
+      if tags_string.is_a? String
+        tags_string.split(',').collect { |t| t.strip }
+      else
+        tags_string
+      end
+    end
+    
+    klass.default :slug do
+      generate_slug
+    end
+    
+    all_children #return original result
+  end
+  
   attr_accessor :content # where everything is stored
   
   ### basic setup methods for types of posts
-  def self.fields(*list) # NOTE: this is a replacing function, not addititve like the others
+  def self.fields(*list)
     self.fields_list = list.make_attrs
     self.allowed_fields_list = [DEFAULT_FIELDS, list.make_attrs].flatten.uniq
   end
@@ -74,12 +98,26 @@ class PostType
   
   def self.special(field, &block)
     field = field.make_attr
-    self.specials_blocks[field.make_attr] = block if fields_list.include? field
+    self.specials_blocks[field] = block if allowed_fields_list.include? field
+  end
+  
+  def self.string_for(field, &block)
+    field = field.make_attr
+    self.string_for_blocks[field] = block if allowed_fields_list.include? field
+  end
+  
+  ### Defaults
+  string_for :tags do |content|
+    content.join(', ')
   end
   
   def self.default(field, &block)
     field = field.make_attr
-    self.defaults_blocks[field.make_attr] = block if fields_list.include? field
+    self.defaults_blocks[field] = block if allowed_fields_list.include? field
+  end
+  
+  def self.html(&block)
+    self.html_block = block
   end
   
   def self.dynamic(field, &block)
@@ -105,8 +143,14 @@ class PostType
     key = key.make_attr
     
     unless value.blank?
-      @content[key] = value
+      # run specials if there is one, or just set the key
+      if self.class.specials_blocks[key]
+        @content[key] = self.class.specials_blocks[key].call(value)
+      else
+        @content[key] = value
+      end
       
+      # run markdowns if there is one
       if self.class.markdown_fields.include?(key)
         markdown = Markdown.new @content[key].strip
         @content[key.html] = markdown.to_html.strip
@@ -114,6 +158,7 @@ class PostType
         @content.delete(key.html)
       end
     else
+      # remove any blank valued keys
       @content.delete(key)
       @content.delete(key.html)
     end
@@ -257,11 +302,6 @@ class PostType
     when Hash
       commit_hash(result)
     end
-    
-    eval_specials # this won't be needed once the set_attr takes care of it
-    eval_defaults # this won't be needed once the get_attr takes care of it
-    parse_tags # TODO: parse_tags needs to be turned into a special block
-    generate_slug # TODO: generate_slug should be turned into a default block
   end
   
   def commit_hash(pairs_hash)
@@ -283,19 +323,12 @@ class PostType
       end
     end
   end
-
-  def eval_specials
-    self.class.specials_blocks.each do |key, block|
-      unless get_attr(key).blank?
-        set_attr(key, block.call(get_attr(key)))
-      end
-    end
-  end
-
-  def parse_tags
-    if get_attr?(:tags) && get_attr(:tags).class == String
-      tags_array = get_attr(:tags).split(',').collect { |t| t.strip }
-      set_attr(:tags, tags_array)
+  
+  def get_string_for key
+    if self.class.string_for_blocks[key]
+      self.class.string_for_blocks[key].call(get_attr(key))
+    else
+      get_attr(key)
     end
   end
 
@@ -314,11 +347,10 @@ class PostType
   def fill_default_fields
     set_default(:published_at, Time.now.utc)
     set_default(:status, default_status)
+    eval_defaults
   end
 
   def generate_slug # OPTIMIZE: this slug generation is ugly
-    return unless blank_attr?(:slug)
-    
     result = ''
   
     unless self.class.always_use_uuid
@@ -344,7 +376,7 @@ class PostType
       result = uuid
     end
   
-    set_attr(:slug, result)
+    result
   end
 
   def truncate_slug(letter_count = 50)
@@ -371,19 +403,27 @@ class PostType
     
     result = fields_to_parse.map do |field|
       unless blank_attr?(field)
-        
-        "#{field}: #{get_attr(field)}" 
-        
-        # TODO: make a way to override this like string_for :content { "hello" }
-      
+        "#{field}: #{get_string_for(field)}" 
       end#unless
-    end.compact.join("\n") << "\n\n"
+    end.compact.join("\n")
     
     unless self.class.primary_field.blank? || blank_attr?(self.class.primary_field)
-      result << get_attr(self.class.primary_field, false) 
+      result << "\n\n" + get_attr(self.class.primary_field, false)
     end
     
     result.strip
   end
   
+  def haml(data, options = {}, locals = {})
+    ::Haml::Engine.new(data, options).render(self, locals)
+  end
+  
+  def to_html
+    unless self.class.html_block.blank?
+      self.instance_eval(&self.class.html_block)
+    else
+      Markdown.new(to_s).to_html
+    end
+  end
+  
 end

data/lib/turbine-core/types/article.rb

@@ -4,6 +4,20 @@ class Article < PostType
   primary :body
   heading :title
   
+  html do
+    haml %Q{
+      - unless blank_attr?(:title)
+        %h2= get_attr(:title)
+
+      - unless blank_attr?(:category)
+        %p.category
+          Category:
+          = get_attr(:category)
+
+      ~ get_attr(:body)
+    }.indents(true)
+  end
+  
   def self.detect?(text)
     true # it can always be an article, so make this last in the preferred order
   end

data/lib/turbine-core/types/audio.rb

@@ -3,6 +3,18 @@ class Audio < PostType
   required :audio_url
   primary :description
   
+  html do
+    haml %Q{
+      - unless blank_attr?(:embed)
+        .embed= get_attr(:embed)
+
+      %p.url
+        %a{:href=>get_attr(:audio_url)}= get_attr(:audio_url)
+
+      ~ get_attr(:description)
+    }.indents(true)
+  end
+  
   def self.detect?(text)
     has_required? text
   end

data/lib/turbine-core/types/chat.rb

@@ -2,6 +2,16 @@ class Chat < PostType
   fields :transcript
   required :transcript
   
+  html do
+    haml %Q{
+      %ol
+        - get_attr(:transcript).each do |line|
+          %li
+            %strong= line.keys.first
+            = line.values.first
+    }.indents(true)
+  end
+  
   # override commit_pairs to make chat transcripts form the Me: pairs stuff
   def commit_array(pairs_array)
     transcript = []

data/lib/turbine-core/types/link.rb

@@ -20,6 +20,15 @@ class Link < PostType
     result
   end
   
+  html do
+    haml %Q{
+      %h2
+        %a{:href=>get_attr(:url)}= get_attr(:title) || get_attr(:url)
+
+      ~ get_attr(:description)
+    }.indents(true)
+  end
+  
   def self.detect?(text)
     has_required? text
   end

data/lib/turbine-core/types/photo.rb

@@ -19,6 +19,19 @@ class Photo < PostType
     'http://' + link_content.gsub(/^http:\/\//, '')
   end
   
+  html do
+    haml %Q{
+      %p
+        - if get_attr?(:url)
+          %a{:href=>get_attr(:url)}
+            %img{:src=>get_attr(:photo_url)}
+        - else
+          %img{:src=>get_attr(:photo_url)}
+
+      ~ get_attr(:caption)
+    }.indents(true)
+  end
+  
   def self.detect?(text)
     has_required? text
   end

data/lib/turbine-core/types/quote.rb

@@ -13,6 +13,17 @@ class Quote < PostType
     quote_content.strip
   end
   
+  html do
+    haml %Q{
+      - unless blank_attr?(:source)
+        %p
+          Source:
+          = get_attr(:source)
+
+      %blockquote~ get_attr(:quote)
+    }.indents(true)
+  end
+  
   def self.detect?(text)
     pairs = get_pairs(text)
     

data/lib/turbine-core/types/review.rb

@@ -12,6 +12,22 @@ class Review < PostType
     'http://' + link_content.gsub(/^http:\/\//, '')
   end
   
+  html do
+    haml %Q{
+      %h2
+        - if get_attr?(:url)
+          %a{:href=>get_attr(:url)}= get_attr(:item)
+        - else
+          = get_attr(:item)
+
+      %p
+        Rating:
+        = get_attr(:rating)
+
+      ~ get_attr(:description)
+    }.indents(true)
+  end
+  
   def self.detect?(text)
     has_required? text
   end

data/lib/turbine-core/types/video.rb

@@ -3,6 +3,18 @@ class Video < PostType
   required :video_url
   primary :description
   
+  html do
+    haml %Q{
+      - unless blank_attr?(:embed)
+        .embed= get_attr(:embed)
+
+      %p.url
+        %a{:href=>get_attr(:video_url)}= get_attr(:video_url)
+
+      ~ get_attr(:description)
+    }.indents(true)
+  end
+  
   def self.detect?(text)
     has_required? text
   end

data/spec/general/post_type_spec.rb

@@ -124,7 +124,7 @@ This will be in One."
     end
     
     y = Yellow.new 'hello'
-    
+    y.save # to trigger defaults
     y.get_attr(:two).should == 2
   end
   
@@ -171,4 +171,155 @@ This will be in One."
   # should save ?
   # should generate slug
   
+  should "to_s all fields" do
+    class Yellow < PostType
+      fields :one, :two, :title, :body
+      primary :body
+      heading :title
+    end
+    
+    yellow = Yellow.new %Q{
+      One: hello1
+      Two: hello2
+      
+      This is the title
+      =================
+      
+      this is the body
+    }.indents
+    
+    yellow.to_s.should == %Q{
+      one: hello1
+      two: hello2
+      title: This is the title
+      
+      this is the body
+    }.indents
+  end
+  
+  should "to_s all fields including slug (if it exists - after save)" do
+    class Yellow < PostType
+      fields :one, :two, :title, :body
+      primary :body
+      heading :title
+    end
+    
+    yellow = Yellow.new %Q{
+      One: hello1
+      Two: hello2
+      
+      This is the title
+      =================
+      
+      this is the body
+    }.indents
+    
+    yellow.save # to trigger defaults
+    
+    yellow.to_s.should == %Q{
+      one: hello1
+      two: hello2
+      title: This is the title
+      status: published
+      slug: this-is-the-title
+      
+      this is the body
+    }.indents
+  end
+  
+  should "set string_for values" do
+    class Yellow < PostType
+      fields :one
+      
+      string_for :one do |content|
+        content.upcase
+      end
+    end
+    
+    Yellow.string_for_blocks[:one].should.not.be.blank?
+  end
+  
+  should "use string_for values" do
+    class Yellow < PostType
+      fields :one
+      
+      string_for :one do |content|
+        content.upcase
+      end
+    end
+    
+    yellow = Yellow.new "one: hello"
+    
+    yellow.to_s.should == "one: HELLO"
+  end
+  
+  should "have a special block for tags" do
+    class Yellow < PostType; end
+    
+    Yellow.specials_blocks[:tags].should.not.be.nil
+  end
+  
+  should "store tags as an array" do
+    class Yellow < PostType; end
+    yellow = Yellow.new "tags: cat, dog, water"
+    yellow.get_attr(:tags).should == ['cat', 'dog', 'water']
+  end
+  
+  should "have a string_for block for tags" do
+    class Yellow < PostType; end
+    
+    Yellow.string_for_blocks[:tags].should.not.be.nil
+  end
+  
+  should "always output the tags array as a comma separated string" do
+    class Yellow < PostType
+      fields :one
+    end
+    
+    yellow = Yellow.new "one: hello\ntags: dog, cat, water"
+    
+    yellow.to_s.should == "one: hello\ntags: dog, cat, water"
+  end
+  
+  should "provide html" do
+    class Yellow < PostType
+      fields :one, :two, :three
+      primary :three
+    end
+    
+    yellow = Yellow.new "one: hello\ntwo: there\n\nhello there"
+    
+    yellow.to_html.should == "<p>one: hello\ntwo: there</p>\n\n<p>hello there</p>\n"
+  end
+  
+  should "keep an html block if provided" do
+    class Yellow < PostType
+      fields :one
+      
+      html {
+        haml %Q{
+          %h1= get_attr(:one)
+        }.indents
+      }
+    end
+    
+    Yellow.html_block.should.not.be.nil
+  end
+  
+  should "use an html block if provided" do
+    class Yellow < PostType
+      fields :one
+      
+      html {
+        haml %Q{
+          %h1= get_attr(:one)
+        }.indents(true)
+      }
+    end
+    
+    yellow = Yellow.new "one: hello"
+    
+    yellow.to_html.should == "<h1>hello</h1>\n"
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: myobie-turbine-core
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Nathan Herald
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-18 00:00:00 -07:00
+date: 2009-04-21 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -38,7 +38,6 @@ files:
 - lib/turbine-core/types/quote.rb
 - lib/turbine-core/types/review.rb
 - lib/turbine-core/types/video.rb
-- spec/general/formats_spec.rb
 - spec/general/post_type_spec.rb
 - spec/post_types/chat_spec.rb
 - spec/post_types/link_spec.rb
@@ -74,7 +73,6 @@ signing_key:
 specification_version: 2
 summary: TODO
 test_files: 
-- spec/general/formats_spec.rb
 - spec/general/post_type_spec.rb
 - spec/post_types/chat_spec.rb
 - spec/post_types/link_spec.rb

data/spec/general/formats_spec.rb

@@ -1,37 +0,0 @@
-require File.join(File.dirname(__FILE__), '../spec_helper.rb')
-
-describe PostType do
-  
-  before do
-    class Yellow; end
-    Object.send(:remove_const, :Yellow)
-  end
-  
-  should "to_s all fields" do
-    class Yellow < PostType
-      fields :one, :two, :title, :body
-      primary :body
-      heading :title
-    end
-    
-    yellow = Yellow.new %Q{
-      One: hello1
-      Two: hello2
-      
-      This is the title
-      =================
-      
-      this is the body
-    }.indents
-    
-    yellow.to_s.should == %Q{
-      one: hello1
-      two: hello2
-      title: This is the title
-      slug: this-is-the-title
-      
-      this is the body
-    }.indents
-  end
-  
-end