textigniter 0.0.32 → 0.0.33

data/README.textile

@@ -56,6 +56,12 @@ These text files are broken down into a meta section and sections delimited by @
 
 The following variables would be available in the template according to the code above: {{ title }}, {{ slug }}, {{ tags }}, {{ author }}, {{ content }}, {{ sidebar }}.
 
+h2. Plugins
+
+Textigniter supports _meta_ custom plugins. You can add custom plugin code to this folder.  Plugins are named after their _meta_ keys found in _.textile_ files.  
+
+For example, if you had a meta key named twitter, you would create a twitter.rb file inside of this directory with a class declaration of @class Textigniter::Plugins::Twitter@. The plugin must have a @parse(value)@ method and must return the parsed value, i.e @return value@
+
 h2. Templates
 
 Textigniter uses _liquid_ templates.  Anything that goes in liquid can go in textigniter.  Checkout the "liquid documentation.":https://github.com/Shopify/liquid/wiki/Liquid-for-Designers

data/lib/skeleton/README.textile

@@ -2,4 +2,4 @@ h1. Textigniter
 
 Welcome to your Textigniter environment. This is pretty simple. 
 
-There are two folders. [.textigniter] is where you'll store the source for your site. [output] is where textigniter builds the static output of yoursite.
+There are three folders. [.textigniter] is where you'll store the source for your site. [output] is where textigniter builds the static output of yoursite. [plugins] is for your custom meta plugins.

data/lib/skeleton/config.yml

@@ -4,6 +4,7 @@ site_description: "A textigniter powered website"
 copyright: "2011 © Textigniter"
 
 # textigniter configuration
-blog_type: article
+blog_type: "article"
 output_environment: "output"
-text_parser: textile
+plugins_environment: "plugins"
+text_parser: "textile"

data/lib/skeleton/plugins/README.textile

@@ -0,0 +1,5 @@
+h1. Custom Plugins
+
+Textigniter supports _meta_ custom plugins. You can add custom plugin code to this folder.  Plugins are named after their _meta_ keys found in _.textile_ files.  
+
+For example, if you had a meta key named twitter, you would create a twitter.rb file inside of this directory with a class declaration of @class Textigniter::Plugins::Twitter@. The plugin must have a @parse(value)@ method and must return the parsed value, i.e @return value@

data/lib/textigniter/build/render_files.rb

@@ -17,7 +17,7 @@ class Textigniter::Build::RenderFiles
       # Switch based on format and build a filename
       case format
         when 'html'
-          filename = item['directory'] + 'index.html'
+          filename = item['directory'] + '/index.html'
         when 'css'
           filename = item['directory'] + '/' + item['filename'] + '.css'
         when 'js'

data/lib/textigniter/build/text_parser.rb

@@ -1,101 +1,92 @@
 # this is the script parser
 class Textigniter::Build::TextParser
+  
+  def plugins
+    @plugins = Textigniter::Plugins.new
+  end
 
   # parse the text and build a hash to send to template rendering
   def process(build_list)
     # Output message
-    STDOUT.puts "Parsing ".yellow_on_black + "[#{$config['text_parser']}]".blue_on_black + " content ".yellow_on_black + "[OK]".green_on_black
+    STDOUT.puts "Parsing ".yellow_on_black + "[#{$config['text_parser']}]".blue_on_black + " content ".yellow_on_black +  "[OK]".green_on_black
+    # parse for plugins
+    plugin_parser = Textigniter::Plugins.new
     # create array to store processed items in
     items = Array.new
     # create an articles array for blog items
     articles = Array.new
     # go through the build list and process
     build_list.each do |f|
+
       # open the file for reading
       file = File.open(f, 'rb')
+
       # store the contents in contents and split it at --
       contents = file.read
       components = contents.split('--')
+
       # load the config from the text file
       meta = YAML::load(components[0])
+      
       # create a new hash to work with
       @h = Hash.new
+
       # parse through the meta
       meta.each do |m|
         @h[m[0]] = m[1]
       end
+
       # add config to the mix
       $config.each do |c|
         @h[c[0]] = c[1]
       end
-      # process for a created_at
-      unless @h.has_key? 'created_at'
-        # string to test agains
-        created_at = File.basename(f, '.textile')[0..9]
-        # is this a valid date?
-        valid = Date.parse(created_at) rescue false
-        if valid
-          @h['created_at'] = created_at
-        end
-      end
-      # get the slug if it exists else calculate
-      unless @h.has_key? 'slug'
-        # if no created_at, no need to fix
-        if @h['created_at'].nil?
-          @h['slug'] = File.basename(f, '.textile')
-        # fix the slug
-        else
-          @h['slug'] = File.basename(f, '.textile').gsub(@h['created_at'][0..9] + "-", '')          
-        end
-      end
-      # the write directory
-      directory = File.dirname(f).sub($twd,$owd) + '/' + @h['slug']
-      directory = directory.sub("#{$config['output_environment']}/content", "#{$config['output_environment']}")
-      directory = directory.sub("#{$config['output_environment']}/index", "#{$config['output_environment']}") + '/'
-      @h['directory'] = directory
+
+      # created_at key
+      @h['created_at'] = File.basename(f, ".#{$config['text_parser']}")[0..9] unless @h.has_key? 'created_at'
+
+      # slug key
+      @h['slug'] = "#{File.dirname(f)}/#{File.basename(f, ".#{$config['text_parser']}")}"  unless @h.has_key? 'slug'
+      
       # get the template if exists else default
-      unless @h.has_key? 'template'
-        @h['template'] = 'default'
-      end
+      @h['template'] = 'default' unless @h.has_key? 'template'
+      
       # gather the rest of the components into key value and convert
-      components[1..-1].each do |component|
-        # split into key value 
-        kv = component.split("\n", 2)
-        # do some cleanup
-        key = kv[0].strip
-        content = parse(kv[1].strip)
-        # store into the list
-        @h[key] = content
-      end
-      # check if blog_type
+      @h = components_parser(components, @h)
+            
+      # run through plugin parser
+      @h = plugin_parser.parse(@h)
+
+      # set slug to directory
+      @h['directory'] = @h['slug']
+      
+      # delete the slug key after its been renamed to directory
+      @h.delete("slug")
+      
+      # check if blog posts according to the type key
+      # I feel like there is probably a better way to do this.
       if @h.has_key? 'type'
         if @h['type'] == $config['blog_type']
           articles.push @h
         end
       end
+      
       # push processed item onto the array
       items.push @h
     end  
+    
     # create a super object to pass
     @results = Hash.new
+    
     # store files to process
     @results['items'] = items
+    
     # store blog posts to separate key
     @results['articles'] = articles  
-    # process blog articles
-    # process_blog(articles)
+
     # return the items
     return @results
   end
-  
-  # process blog articles
-  def process_blog(articles)
-    # iterate through articles
-    articles.each do |article|
-      # puts "#{article['title']}"
-    end
-  end
-  
+    
   # parse text
   def parse(content)
     case $config['text_parser']
@@ -120,7 +111,24 @@ class Textigniter::Build::TextParser
     end
   end
   
+  # split out components to key/value pairs
+  def components_parser(components, h)
+    # iterate through components
+    components[1..-1].each do |component|
+      # split into key value 
+      kv = component.split("\n", 2)
+      # do some cleanup
+      key = kv[0].strip
+      content = parse(kv[1].strip)
+      # store into the list
+      h[key] = content
+    end
+    # return h
+    return h
+  end
+  
 end
 
 # requirements
-require 'date'
+require 'date'
+require_relative '../plugins'

data/lib/textigniter/plugins/created_at.rb

@@ -0,0 +1,17 @@
+class Textigniter::Plugins::CreatedAt
+  
+    def parse(value)
+      # is this a valid date?
+      valid = Date.parse(value) rescue false
+      # if valid, pass value back
+      if valid != false
+        created_at = value
+      # if invalid, pass nil
+      else
+        created_at = nil
+      end
+      # return the parsed value
+      return created_at
+    end
+    
+end

data/lib/textigniter/plugins/slug.rb

@@ -0,0 +1,37 @@
+class Textigniter::Plugins::Slug
+  
+  def parse(value)
+
+    # split the value by /
+    values = value.split(/\//)
+    # get the filename
+    filename = values.last
+    # values pop
+    values.pop
+
+    # check for date in slug
+    valid = Date.parse(filename[0..9]) rescue false
+    
+    # slug does contain date
+    if valid != false
+      slug = "#{values.join('/')}/#{filename.gsub(filename[0..9] + "-", '')}"      
+    # slug does not contain date
+    else
+      slug = value
+    end
+    
+    # check for path name
+    slug = "#{$owd}/#{slug}" unless slug.include? $twd
+
+    # check for content/index
+    slug = slug.sub('content/index', 'content')
+    
+    # replace twd with owd
+    slug = slug.sub("#{$twd}/content", "#{$owd}")
+    
+    # return parsed slug
+    return slug
+        
+  end
+  
+end

data/lib/textigniter/plugins/tags.rb

@@ -0,0 +1,12 @@
+class Textigniter::Plugins::Tags
+  
+  def initialize
+    
+  end
+  
+  def parse(value)
+    
+    return value
+  end
+  
+end

data/lib/textigniter/plugins/twitter.rb

@@ -0,0 +1,12 @@
+class Textigniter::Plugins::Twitter
+  
+  def initialize
+    
+  end
+  
+  def parse(value)
+    
+    return value
+  end
+  
+end

data/lib/textigniter/plugins/type.rb

@@ -0,0 +1,12 @@
+class Textigniter::Plugins::Type
+  
+  def initialize
+  
+  end
+  
+  def parse(value)
+
+    return value
+  end
+  
+end

data/lib/textigniter/plugins.rb

@@ -0,0 +1,66 @@
+class Textigniter::Plugins
+  
+  # parse through the hash
+  def parse(h)
+    # create a hash to store processed items
+    @h = Hash.new
+    # require plugins
+    require_plugins(plugins)
+    # load plugins
+    splugin = load_plugins(plugins)
+    # iterate through the hash
+    h.each do |key, value|
+      # check for plugin methods
+      if splugin.has_key?(key)
+        @h["#{key}"] = splugin["#{key}"].parse(value)
+      else
+        @h["#{key}"] = value
+      end
+    end
+    # return the hash
+    return @h
+  end
+  
+  # gather a list of textigniter and custom plugins
+  def plugins
+    # textigniter plugins
+    textigniter_plugins = Dir.glob("#{File.dirname(__FILE__)}/plugins/**/*.rb")
+    # custom plugins
+    custom_plugins = Dir.glob("#{Dir::pwd}/plugins/**/*.rb")
+    # join plugins
+    @plugins = textigniter_plugins | custom_plugins
+  end
+  
+  # require the plugins for use
+  def require_plugins(plugins)
+    plugins.each do |plugin|
+      # require the plugin
+      require_relative plugin
+    end
+  end
+  
+  # load the plugins and return a super object
+  def load_plugins(plugins)
+    # create a hash to store plugins in
+    splugin = Hash.new
+    # iterate through list
+    plugins.each do |plugin|
+      # buld the class name
+      classname = camelcase(File.basename(plugin, '.rb'))
+      # load the class
+      loaded_class = eval("Textigniter::Plugins::#{classname}").new
+      # add it to splugin
+      splugin["#{File.basename(plugin, '.rb')}"] = loaded_class
+    end
+    # return the super plugin
+    return splugin
+  end
+  
+  def camelcase(phrase)
+    phrase.gsub!(/_/, ' ')
+    phrase.gsub!(/\b\w/){$&.upcase}
+    phrase.gsub!(/ /, '')
+    return phrase
+  end
+    
+end

data/lib/textigniter/scrub.rb

@@ -3,7 +3,7 @@
 # that you have added to the public_html folder so be sure to back those up.
 class Textigniter::Scrub
   
-  def initialize
+  def initialize(args)
     # Output start message
     STDOUT.puts "Scrubbing textigniter environment".yellow_on_black
     # Check for an existing environment
@@ -21,6 +21,7 @@ class Textigniter::Scrub
     cwd = Dir::pwd + '/'
     # Scrub the directory, no turning back
     scrub_directory(cwd + '.textigniter')
+    scrub_directory(cwd + 'plugins')
     scrub_directory(cwd + "#{$config['output_environment']}")
     # Files to delete as well
     files = [ cwd + "README.textile", cwd + "config.yml" ]

data/lib/textigniter.rb

@@ -14,7 +14,7 @@ class Textigniter
   # Contains a switch for arguments passed via the command line
   def initialize
     # get start time
-    beginning = Time.now
+    $beginning = Time.now
     
     # Get command line arguments arguments
     cmd = ARGV[0]
@@ -56,12 +56,12 @@ class Textigniter
       when "init"
         Textigniter.init(args)
       when "scrub"
-        Textigniter.scrub
+        Textigniter.scrub(args)
       else 
         Textigniter.help(args)
     end
     # print out elapsed time
-    puts "Time elapsed: ".yellow_on_black + "#{Time.now - beginning} seconds".white_on_black
+    puts "Time elapsed: ".yellow_on_black + "#{Time.now - $beginning} seconds".white_on_black
     # pretty up
     STDOUT.puts "\r\n"
   end
@@ -85,9 +85,9 @@ class Textigniter
   end
   
   # Initialize a new scrub object
-  def self.scrub
+  def self.scrub(args)
     # create a new scrub instance
-    @scrub = Scrub.new
+    @scrub = Scrub.new(args)
     @scrub.scrub
   end
 

data/textigniter.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
   s.rubygems_version        = '1.9.2'
 
   s.name                    = 'textigniter'
-  s.version                 = '0.0.32'
+  s.version                 = '0.0.33'
   s.executables             << 'textigniter'
   s.date                    = '2011-11-19'
   
@@ -43,16 +43,23 @@ Gem::Specification.new do |s|
     lib/skeleton/.textigniter/layouts/blog.liquid
     lib/skeleton/.textigniter/layouts/default.liquid
     lib/skeleton/.textigniter/layouts/partials
+    lib/skeleton/plugins/README.textile
     lib/textigniter.rb
     lib/textigniter/build.rb
     lib/textigniter/help.rb
     lib/textigniter/init.rb
+    lib/textigniter/plugins.rb
     lib/textigniter/scrub.rb
     lib/textigniter/build/render_files.rb
     lib/textigniter/build/script_parser.rb
     lib/textigniter/build/style_parser.rb
     lib/textigniter/build/template_parser.rb
     lib/textigniter/build/text_parser.rb
+    lib/textigniter/plugins/created_at.rb
+    lib/textigniter/plugins/slug.rb
+    lib/textigniter/plugins/type.rb
+    lib/textigniter/plugins/tags.rb
+    lib/textigniter/plugins/twitter.rb
   ]
   # = MANIFEST =
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textigniter
 version: !ruby/object:Gem::Version
-  version: 0.0.32
+  version: 0.0.33
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &70139173890900 !ruby/object:Gem::Requirement
+  requirement: &70119255384020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 4.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70139173890900
+  version_requirements: *70119255384020
 - !ruby/object:Gem::Dependency
   name: kramdown
-  requirement: &70139173890360 !ruby/object:Gem::Requirement
+  requirement: &70119255382600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.13.0
   type: :runtime
   prerelease: false
-  version_requirements: *70139173890360
+  version_requirements: *70119255382600
 - !ruby/object:Gem::Dependency
   name: liquid
-  requirement: &70139173889860 !ruby/object:Gem::Requirement
+  requirement: &70119255380940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70139173889860
+  version_requirements: *70119255380940
 - !ruby/object:Gem::Dependency
   name: less
-  requirement: &70139173889320 !ruby/object:Gem::Requirement
+  requirement: &70119255380280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70139173889320
+  version_requirements: *70119255380280
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &70139173888720 !ruby/object:Gem::Requirement
+  requirement: &70119255379760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70139173888720
+  version_requirements: *70119255379760
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &70139173887660 !ruby/object:Gem::Requirement
+  requirement: &70119255379000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70139173887660
+  version_requirements: *70119255379000
 description: ! "    Textigniter is a lightweight static site generator based on textile
   (markdown optional), liquid, less, and coffeescript.  There are no plans for textigniter
   to support other parsers. Keeping it clean yet powerful. \n"
@@ -104,16 +104,23 @@ files:
 - lib/skeleton/.textigniter/layouts/about.liquid
 - lib/skeleton/.textigniter/layouts/blog.liquid
 - lib/skeleton/.textigniter/layouts/default.liquid
+- lib/skeleton/plugins/README.textile
 - lib/textigniter.rb
 - lib/textigniter/build.rb
 - lib/textigniter/help.rb
 - lib/textigniter/init.rb
+- lib/textigniter/plugins.rb
 - lib/textigniter/scrub.rb
 - lib/textigniter/build/render_files.rb
 - lib/textigniter/build/script_parser.rb
 - lib/textigniter/build/style_parser.rb
 - lib/textigniter/build/template_parser.rb
 - lib/textigniter/build/text_parser.rb
+- lib/textigniter/plugins/created_at.rb
+- lib/textigniter/plugins/slug.rb
+- lib/textigniter/plugins/type.rb
+- lib/textigniter/plugins/tags.rb
+- lib/textigniter/plugins/twitter.rb
 - LICENSE
 homepage: http://github.com/kalebheitzman/textigniter
 licenses: