smartgen 0.4.0 → 0.5.0

data/ChangeLog.md

@@ -1,3 +1,17 @@
+0.5.0
+-----
+
+* Added ERB engine
+* Added a sample Thorfile and fixed thor generator description so that it can be properly used.
+* Configuration options are passed directly to generators to avoid duplicate options definitions
+* Allowing one to pass a different resource name for rake task
+* Metadata will be passed as an ObjectHash to renderers and engines
+
+0.4.0
+-----
+
+* Passing metadata to engines and their preprocessors.
+
 0.3.0
 -----
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smartgen (0.4.0)
+    smartgen (0.5.0)
       RedCloth (= 4.2.3)
       activesupport (>= 2.3.5)
       bluecloth (>= 2.0.9)
@@ -14,7 +14,7 @@ GEM
   remote: http://rubygems.org/
   specs:
     RedCloth (4.2.3)
-    activesupport (3.0.4)
+    activesupport (2.3.5)
     archive-tar-minitar (0.5.2)
     bluecloth (2.0.10)
     columnize (0.3.2)

data/README.md

@@ -161,6 +161,13 @@ Then you can call both `my_doc` and `watch_my_doc`:
     rake my_doc          # generates files right away
     rake watch_my_doc    # generates files and watch for changes
 
+## Related Gems
+
+* [Smartgen SyntaxHighlighter](http://github.com/smartgen/smartgen_syntaxhighlighter) -- Adds support to use Alex Gorbatchev's Syntax Highlighter plugin with smartgen
+* [Smartgen ERB](http://github.com/smartgen/smartgen_erb) -- A ERB preprocessor for smartgen engines
+
+There are some
+
 ## Contributors
 
 * [Vicente Mundim](http://github.com/vicentemundim) _(author)_

data/lib/smartgen/configuration.rb

@@ -1,7 +1,6 @@
 module Smartgen
-  
   # Holds configurations for each smartgen resource.
-  class Configuration
+  class Configuration < ObjectHash
     
     # An array with all the source files that should be generated.
     #
@@ -18,52 +17,5 @@ module Smartgen
     # default:
     #   nil
     attr_accessor :output_folder
-    
-    # An optional layout file to be used when rendering each page.
-    #
-    # default:
-    #   nil
-    attr_accessor :layout
-    
-    # An array of dirs to be copied to output folder.
-    #
-    # It will copy the contents of each directory to the output folder,
-    # preserving the directory itself. So, if output folder is '/public/doc',
-    # then 'doc/stylesheets' will be copied to 'public/docs/stylesheets'.
-    #
-    # default:
-    #   []
-    attr_accessor :assets
-    
-    # A YAML metadata file used to specify metadata used in all pages, or even
-    # specific page metadata.
-    #
-    # default:
-    #   nil
-    attr_accessor :metadata_file
-    
-    # Whether indexer should be used or not.
-    #
-    # default:
-    #   false
-    attr_accessor :use_indexer
-    
-    # Whether indexer should add numbered indexes on header tags.
-    #
-    # Only makes sense if #use_indexer is true
-    #
-    # default:
-    #   false
-    attr_accessor :numbered_index
-    
-    def initialize
-      @src_files = []
-      @output_folder = nil
-      @layout = nil
-      @assets = []
-      @metadata_file = nil
-      @use_indexer = false
-      @numbered_index = false
-    end
   end
 end

data/lib/smartgen/engines.rb

@@ -1,3 +1,4 @@
 require File.expand_path('engines/base', File.dirname(__FILE__))
 require File.expand_path('engines/textile', File.dirname(__FILE__))
 require File.expand_path('engines/markdown', File.dirname(__FILE__))
+require File.expand_path('engines/erb', File.dirname(__FILE__))

data/lib/smartgen/engines/base.rb

@@ -14,8 +14,8 @@ module Smartgen
       end
 
       # Process a file, calling each pre processor if any.
-      def process(body, metadata={})
-        parse(pre_process(body, metadata))
+      def process(body, metadata=Smartgen::ObjectHash.new)
+        parse(pre_process(body, metadata), metadata)
       end
 
       # Returns true if the given extension is supported by this engine.
@@ -39,7 +39,7 @@ module Smartgen
           end
         end
 
-        def parse(body)
+        def parse(body, metadata)
           body
         end
 

data/lib/smartgen/engines/erb.rb

@@ -0,0 +1,15 @@
+module Smartgen
+  module Engine
+    # Processes erb files, supporting '.erb' extension.
+    class ERB < Base
+      protected
+        def parse(body, metadata)
+          ::ERB.new(body).result(binding)
+        end
+
+        def extensions
+          @extensions ||= ['.erb']
+        end
+    end
+  end
+end

data/lib/smartgen/engines/markdown.rb

@@ -5,7 +5,7 @@ module Smartgen
     # Processes markdown files, supporting both '.md' and '.markdown' extensions.
     class Markdown < Base
       protected
-        def parse(body)
+        def parse(body, metadata)
           BlueCloth.new(body).to_html
         end
 

data/lib/smartgen/engines/textile.rb

@@ -5,7 +5,7 @@ module Smartgen
     # Processes textile files, supporting '.textile' extension.
     class Textile < Base
       protected
-        def parse(body)
+        def parse(body, metadata)
           RedCloth.new(body).to_html
         end
 

data/lib/smartgen/generator.rb

@@ -5,26 +5,28 @@ module Smartgen
   class Generator < Thor::Group
     include Thor::Actions
 
-    desc "An array with all the source files that should be generated. See Configuration#src_files"
-    argument :src_files, :type => :array
+    desc "Process given markup files, generating HTML, optionally using a layout and copying assets."
 
-    desc "The output folder, where all generated files will be located. See Configuration#output_folder"
-    argument :output_folder, :type => :string
+    argument :src_files, :type => :array,
+             :desc => "An array with all the source files that should be generated."
 
-    desc "An optional layout file to be used when rendering each page. See Configuration#layout"
-    class_option :layout, :type => :string
+    argument :output_folder, :type => :string,
+             :desc => "The output folder, where all generated files will be located."
 
-    desc "An array of dirs to be copied to output folder. See Configuration#assets"
-    class_option :assets, :type => :array, :default => []
+    class_option :layout, :type => :string,
+                 :desc => "An optional layout file to be used when rendering each page."
 
-    desc "A YAML metadata file used to specify metadata used in all pages, or even specific page metadata. See Configuration#metadata_file"
-    class_option :metadata_file, :type => :string
+    class_option :assets, :type => :array, :default => [],
+                 :desc => "An array of dirs to be copied to output folder."
 
-    desc "Whether indexer should be used or not. See Configuration#use_indexer"
-    class_option :use_indexer, :type => :boolean, :default => false
+    class_option :metadata_file, :type => :string,
+                 :desc => "A YAML metadata file used to specify metadata used in all pages, or even specific page metadata."
 
-    desc "Whether indexer should add numbered indexes on header tags. See Configuration#numbered_index"
-    class_option :numbered_index, :type => :boolean, :default => false
+    class_option :use_indexer, :type => :boolean, :default => false,
+                 :desc => "Whether indexer should be used or not."
+
+    class_option :numbered_index, :type => :boolean, :default => false,
+                 :desc => "Whether indexer should add numbered indexes on header tags."
 
     def create_output_folder
       destination_root = output_folder
@@ -85,9 +87,9 @@ module Smartgen
 
       def load_metadata
         if options["metadata_file"]
-          YAML.load(File.read(options["metadata_file"]))
+          Smartgen::ObjectHash.new(YAML.load(File.read(options["metadata_file"])))
         else
-          {}
+          Smartgen::ObjectHash.new
         end
       end
 
@@ -106,7 +108,7 @@ module Smartgen
       end
 
       def markup_files
-        Dir[*src_files].select { |f| supported?(File.extname(f)) }.map do |markup_filename|
+        supported_src_files.map do |markup_filename|
           MarkupFile.new markup_filename, markup_file_options
         end
       end
@@ -119,10 +121,20 @@ module Smartgen
         end
       end
 
+      def supported_src_files
+        Dir[*src_files].select do |path|
+          supported?(File.extname(path)) && !layout?(path)
+        end
+      end
+
       def supported?(extension)
         MarkupFile.engines.one? { |engine| engine.supported?(extension) }
       end
 
+      def layout?(file)
+        File.expand_path(options[:layout]) == File.expand_path(file) if has_layout?
+      end
+
       def output_folder_path(path)
         File.join(output_folder, path)
       end

data/lib/smartgen/markup_file.rb

@@ -40,7 +40,7 @@ module Smartgen
     def initialize(path, options={})
       @path = path
       @extension = File.extname(path)
-      @filename = File.basename(path, @extension)
+      @filename = filename_for(path)
       @engine = engine_for(@extension) || self.class.engines.first
 
       @contents = engine.process(raw_contents, options[:metadata])
@@ -64,7 +64,7 @@ module Smartgen
       # first ones are the ones with higher priority.
       def engines
         if @engines.blank?
-          @engines = [Smartgen::Engine::Textile.new, Smartgen::Engine::Markdown.new]
+          @engines = [Smartgen::Engine::Textile.new, Smartgen::Engine::Markdown.new, Smartgen::Engine::ERB.new]
         end
 
         @engines
@@ -87,5 +87,9 @@ module Smartgen
 
         nil
       end
+
+      def filename_for(path)
+        File.basename(File.basename(path, @extension), '.html')
+      end
   end
 end

data/lib/smartgen/object_hash.rb

@@ -11,21 +11,31 @@ module Smartgen
     def dup
       Smartgen::ObjectHash.new(self)
     end
-    
+
     def respond_to?(method)
-      has_key?(method) or super
+      has_key?(method) || (setter?(method) && has_key?(method.to_s.chop)) || super
+    end
+
+    def inspect
+      "ObjectHash(#{super})"
     end
-    
+
     protected
       def method_missing(name, *args)
         if has_key?(name)
           self[name]
+        elsif setter?(name)
+          self[name.to_s.chop] = args.first
         else
-          puts "warning: key #{name} not found on #{inspect}"
+          $stderr.puts "warning: key #{name} not found on #{inspect}"
           Smartgen::ObjectHash.new
         end
       end
-      
+
+      def setter?(method)
+        method.to_s.end_with?('=')
+      end
+
       def convert_value(value)
         case value
         when Hash

data/lib/smartgen/rake_task.rb

@@ -20,15 +20,31 @@ module Smartgen
   #
   # It yields a Configuration, in fact it calls Resource#configure, so you
   # can use any of the configurations here.
+  #
+  # You may also use an existing configuration, while still having a different
+  # task name:
+  #   Smartgen[:my_config] do |config|
+  #     config.layout = 'layout.html.erb'
+  #   end
+  #
+  #   Smartgen::RakeTask.new :watcher, :my_config do |config|
+  #     config.src_files = ['doc/**/*']
+  #     config.output_folder = 'public/doc'
+  #   end
+  #
+  # This will use Smartgen[:generate_doc] config, but you will call it with:
+  #
+  #   rake watcher
   class RakeTask < ::Rake::TaskLib
-    def initialize(name=nil, &block)
-      name = name || :smartgen
+    def initialize(resource_or_task_name=nil, resource_name=nil, &block)
+      task_name = resource_or_task_name || :smartgen
+      resource_name = resource_name || task_name
       
-      Smartgen[name].configure(&block)
+      Smartgen[resource_name].configure(&block)
       
       desc("Generate smartgen files") unless ::Rake.application.last_comment
-      task name do
-        Smartgen[name].generate!
+      task task_name do
+        Smartgen[resource_name].generate!
       end
     end
   end

data/lib/smartgen/renderers/erb.rb

@@ -6,10 +6,7 @@ module Smartgen
       #
       # It exposes +markup_file+ variable and its +metadata+ to the ERB layout.
       def render(layout, markup_file, metadata={})
-        metadata = Smartgen::ObjectHash.new(metadata)
-
-        template = ::ERB.new(layout)
-        template.result(binding)
+        ::ERB.new(layout).result(binding)
       end
     end
   end

data/lib/smartgen/resource.rb

@@ -31,19 +31,11 @@ module Smartgen
     
     private
       def generator
-        Smartgen::Generator.new(arguments, options)
+        Smartgen::Generator.new(arguments, config)
       end
       
       def arguments
         [config.src_files, config.output_folder]
       end
-      
-      def options
-        {
-          :metadata_file => config.metadata_file,
-          :layout => config.layout,
-          :assets => config.assets
-        }
-      end
   end
 end

data/lib/smartgen/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 module Smartgen
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/fixtures/expectations/common/another_index.html

@@ -0,0 +1,13 @@
+<h1>Here is some header</h1>
+
+<p>And here is a paragraph</p>
+
+<ul>
+<li>some bullet lists with <strong>style</strong></li>
+<li>some bullet lists with <em>style</em></li>
+</ul>
+
+
+<h2>Another header</h2>
+
+<p>With some text</p>

data/spec/fixtures/expectations/common/index.html

@@ -0,0 +1,8 @@
+<h1>Here is some header</h1>
+<p>And here is a paragraph</p>
+<ul>
+	<li>some bullet lists with <strong>style</strong></li>
+	<li>some bullet lists with <em>style</em></li>
+</ul>
+<h2>Another header</h2>
+<p>With some text</p>

data/spec/fixtures/expectations/common/other_index.html

@@ -0,0 +1,13 @@
+<h1>Here is some header</h1>
+
+<p>And here is a paragraph</p>
+
+<ul>
+<li>some bullet lists with <strong>style</strong></li>
+<li>some bullet lists with <em>style</em></li>
+</ul>
+
+
+<h2>Another header</h2>
+
+<p>With some text</p>