smartgen 0.3.0 → 0.4.0

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    smartgen (0.3.0)
-      RedCloth (>= 4.2.3)
+    smartgen (0.4.0)
+      RedCloth (= 4.2.3)
       activesupport (>= 2.3.5)
       bluecloth (>= 2.0.9)
       directory_watcher (>= 1.3.2)
@@ -14,9 +14,9 @@ GEM
   remote: http://rubygems.org/
   specs:
     RedCloth (4.2.3)
-    activesupport (2.3.5)
+    activesupport (3.0.4)
     archive-tar-minitar (0.5.2)
-    bluecloth (2.0.9)
+    bluecloth (2.0.10)
     columnize (0.3.2)
     diff-lcs (1.1.2)
     directory_watcher (1.3.2)
@@ -26,14 +26,14 @@ GEM
       ruby_core_source (>= 0.1.4)
     nokogiri (1.4.4)
     rake (0.8.7)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
+    rspec-mocks (2.5.0)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
@@ -55,7 +55,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  RedCloth (>= 4.2.3)
+  RedCloth (= 4.2.3)
   activesupport (>= 2.3.5)
   bluecloth (>= 2.0.9)
   directory_watcher (>= 1.3.2)

data/README.md

@@ -108,7 +108,7 @@ You may create as many resource configurations as you want. When you call `Smart
       config.layout = 'doc/layout.html.erb'
       config.metadata_file = 'doc/metadata.yml'
     end
-    
+
     Smartgen[:some_other_documentation].configure do |config|
       config.src_files = ['other_doc/**/*']
       config.output_folder = 'public/other_docs'
@@ -123,7 +123,7 @@ You may create as many resource configurations as you want. When you call `Smart
 You may also use a rake task:
 
     require 'smartgen/rake_task'
-    
+
     Smartgen::RakeTask.new :my_doc do |config|
       config.src_files = ['doc/**/*']
       config.output_folder = 'public/docs'
@@ -167,6 +167,7 @@ Then you can call both `my_doc` and `watch_my_doc`:
 * [Emerson Leite](http://github.com/emerleite)
 * [Rodrigo Lopes](http://github.com/rodvlopes)
 * [Marcos Silva Pereira](http://github.com/marcospereira)
+* [Wandenberg Peixoto](http://github.com/wandenberg)
 
 ## Copyright
 

data/lib/smartgen/engines/base.rb

@@ -8,21 +8,21 @@ module Smartgen
     class Base
       # An array of pre processors that will process files before conversion.
       class_inheritable_accessor :pre_processors
-      
+
       def initialize
         self.pre_processors ||= []
       end
-      
+
       # Process a file, calling each pre processor if any.
-      def process(body)
-        parse(pre_process(body))
+      def process(body, metadata={})
+        parse(pre_process(body, metadata))
       end
-      
+
       # Returns true if the given extension is supported by this engine.
       def supported?(extension)
         extensions.include?(extension)
       end
-      
+
       class << self
         # Registers a pre processor for this engine.
         def register(processor)
@@ -30,11 +30,11 @@ module Smartgen
           self.pre_processors << processor
         end
       end
-      
+
       protected
-        def pre_process(body)
+        def pre_process(body, metadata={})
           self.pre_processors.inject(body) do |processed_body, pre_processor|
-            processed_body = pre_processor.process(processed_body)
+            processed_body = pre_processor.process(processed_body, metadata)
             processed_body
           end
         end
@@ -48,4 +48,4 @@ module Smartgen
         end
     end
   end
-end
+end

data/lib/smartgen/generator.rb

@@ -4,60 +4,60 @@ module Smartgen
   # Generates files, possibly using layout and copying assets.
   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 "The output folder, where all generated files will be located. See Configuration#output_folder"
     argument :output_folder, :type => :string
-    
+
     desc "An optional layout file to be used when rendering each page. See Configuration#layout"
     class_option :layout, :type => :string
-    
+
     desc "An array of dirs to be copied to output folder. See Configuration#assets"
     class_option :assets, :type => :array, :default => []
-    
+
     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
-    
+
     desc "Whether indexer should be used or not. See Configuration#use_indexer"
     class_option :use_indexer, :type => :boolean, :default => false
-    
+
     desc "Whether indexer should add numbered indexes on header tags. See Configuration#numbered_index"
     class_option :numbered_index, :type => :boolean, :default => false
-    
+
     def create_output_folder
       destination_root = output_folder
       empty_directory output_folder
     end
-    
+
     def generate_files
       markup_files.each do |markup_file|
         create_file output_folder_path("#{markup_file.filename}.html"), process_file(markup_file), :force => true
       end
     end
-    
+
     def copy_assets
       options[:assets].each do |dir|
         self.class.source_root File.dirname(dir)
         directory File.basename(dir), output_folder_path(File.basename(dir)), :force => true
       end
     end
-    
+
     class << self
       # Returns the current renderer.
       def renderer
         @renderer ||= Smartgen::Renderer::ERB.new
       end
-      
+
       # Sets the renderer used when generating files.
       def renderer=(value)
         @renderer = value
       end
     end
-    
+
     private
-    
+
       def process_file(markup_file)
         if has_layout?
           self.class.renderer.render(layout, markup_file, metadata_for(markup_file))
@@ -65,21 +65,24 @@ module Smartgen
           markup_file.contents
         end
       end
-      
+
       def has_layout?
         options["layout"].present?
       end
-      
+
       def layout
         File.read(options["layout"])
       end
-      
+
       def metadata_for(markup_file)
-        metadata = load_metadata
-        add_current_page_data_to(metadata, markup_file)
+        add_current_page_data_to(markup_file)
         metadata
       end
-      
+
+      def metadata
+        @metadata ||= load_metadata
+      end
+
       def load_metadata
         if options["metadata_file"]
           YAML.load(File.read(options["metadata_file"]))
@@ -87,41 +90,41 @@ module Smartgen
           {}
         end
       end
-      
-      def add_current_page_data_to(metadata, markup_file)
+
+      def add_current_page_data_to(markup_file)
         if metadata.has_key?("pages")
-          metadata["current_page"] = page_metadata(metadata, markup_file) || {}
+          metadata["current_page"] = page_metadata(markup_file) || {}
         end
       end
-      
-      def page_metadata(metadata, markup_file)
+
+      def page_metadata(markup_file)
         metadata["pages"].select { |page| current_page?(page, markup_file) }.first
       end
-    
+
       def current_page?(page, markup_file)
         page.has_key?("file") && page["file"] == markup_file.filename
       end
-      
+
       def markup_files
         Dir[*src_files].select { |f| supported?(File.extname(f)) }.map do |markup_filename|
           MarkupFile.new markup_filename, markup_file_options
         end
       end
-      
+
       def markup_file_options
         if options[:numbered_index]
-          { :indexer => { :numbered_index => true } }
+          { :indexer => { :numbered_index => true }, :metadata => metadata }
         else
-          { :indexer => options[:use_indexer] }
+          { :indexer => options[:use_indexer], :metadata => metadata  }
         end
       end
-      
+
       def supported?(extension)
         MarkupFile.engines.one? { |engine| engine.supported?(extension) }
       end
-      
+
       def output_folder_path(path)
         File.join(output_folder, path)
       end
   end
-end
+end

data/lib/smartgen/markup_file.rb

@@ -1,16 +1,16 @@
 require 'active_support/core_ext/object/blank'
 
 module Smartgen
-  
+
   # A MarkupFile is created for each file that will be generated.
   #
   # It is also exposed in layouts, as +markup_file+ variable.
   #
   # It receives the +path+ of the file and process it using the first suitable
   # engine, based on the extension of the file.
-  # 
+  #
   # It can also receive an options hash with indexer options:
-  # 
+  #
   #   MarkupFile.new 'some/path', :indexer => true
   #
   # Or, if you want to pass options for the Indexer:
@@ -18,44 +18,45 @@ module Smartgen
   #   MarkupFile.new 'some/path', :indexer => { :numbered_index => true }
   #
   class MarkupFile
-    
+
     # The path of the file.
     attr_accessor :path
-    
+
     # The name of the file, without extension.
     attr_accessor :filename
-    
+
     # The extension of the file.
     attr_accessor :extension
-    
+
     # The engine used to process the file.
     attr_accessor :engine
-    
+
     # The contents of the file after processing.
     attr_accessor :contents
-    
+
     # The indexer instance, if +options[:indexer]+ is given
     attr_accessor :indexer
-    
+
     def initialize(path, options={})
       @path = path
       @extension = File.extname(path)
       @filename = File.basename(path, @extension)
       @engine = engine_for(@extension) || self.class.engines.first
-      
-      @contents = engine.process(raw_contents)
-      
+
+      @contents = engine.process(raw_contents, options[:metadata])
+
       if options[:indexer]
         @indexer = Smartgen::Indexer.new(@contents, options[:indexer])
         @contents = @indexer.result
       end
+
     end
-    
+
     # The contents of the file before processing.
     def raw_contents
       File.read(path)
     end
-    
+
     class << self
       # Returns an array with the supported engines.
       #
@@ -65,10 +66,10 @@ module Smartgen
         if @engines.blank?
           @engines = [Smartgen::Engine::Textile.new, Smartgen::Engine::Markdown.new]
         end
-        
+
         @engines
       end
-      
+
       # Register an engine to be used when generating files.
       #
       # The engine will be added with the highest priority.
@@ -76,15 +77,15 @@ module Smartgen
         engines.unshift engine.new
       end
     end
-    
+
     private
-    
+
       def engine_for(extension)
         self.class.engines.each do |engine|
           return engine if engine.supported?(extension)
         end
-        
+
         nil
       end
   end
-end
+end

data/lib/smartgen/version.rb

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

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: smartgen
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Vicente Mundim
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-28 00:00:00 -02:00
+date: 2011-02-10 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 43
         segments: 
         - 0
         - 14
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 0
         - 5
@@ -58,7 +55,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 2
         - 3
@@ -72,9 +68,8 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 49
         segments: 
         - 4
         - 2
@@ -90,7 +85,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
         segments: 
         - 2
         - 0
@@ -106,7 +100,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 1
         - 4
@@ -122,7 +115,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
         segments: 
         - 1
         - 3
@@ -138,7 +130,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 2
         - 3
@@ -156,65 +147,28 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/smartgen/configuration.rb
+- lib/smartgen.rb
 - lib/smartgen/engines/base.rb
 - lib/smartgen/engines/markdown.rb
 - lib/smartgen/engines/textile.rb
+- lib/smartgen/renderers.rb
 - lib/smartgen/engines.rb
+- lib/smartgen/renderers/erb.rb
+- lib/smartgen/version.rb
 - lib/smartgen/generator.rb
-- lib/smartgen/indexer.rb
 - lib/smartgen/markup_file.rb
+- lib/smartgen/indexer.rb
+- lib/smartgen/watcher.rb
+- lib/smartgen/resource.rb
 - lib/smartgen/object_hash.rb
 - lib/smartgen/rake_task.rb
-- lib/smartgen/renderers/erb.rb
-- lib/smartgen/renderers.rb
-- lib/smartgen/resource.rb
-- lib/smartgen/version.rb
-- lib/smartgen/watcher.rb
+- lib/smartgen/configuration.rb
 - lib/smartgen/watcher_rake_task.rb
-- lib/smartgen.rb
 - Gemfile
 - Gemfile.lock
 - Rakefile
 - README.md
 - ChangeLog.md
-- spec/fixtures/expectations/common/another_index.html
-- spec/fixtures/expectations/common/index.html
-- spec/fixtures/expectations/common/other_index.html
-- spec/fixtures/expectations/indexer/index_with_indexer.html
-- spec/fixtures/expectations/indexer/index_with_indexer_and_numbered_index.html
-- spec/fixtures/expectations/with_layout/index.html
-- spec/fixtures/expectations/with_layout/index_with_metadata.html
-- spec/fixtures/expectations/with_layout/index_with_specific_metadata.html
-- spec/fixtures/src/assets/images/image.gif
-- spec/fixtures/src/assets/javascripts/somelib.js
-- spec/fixtures/src/assets/stylesheets/style.css
-- spec/fixtures/src/common/another_index.md
-- spec/fixtures/src/common/index.textile
-- spec/fixtures/src/common/other_index.markdown
-- spec/fixtures/src/common/somefile
-- spec/fixtures/src/indexer/index_with_indexer.textile
-- spec/fixtures/src/indexer/index_with_indexer_and_numbered_index.textile
-- spec/fixtures/src/layout.html.erb
-- spec/fixtures/src/layout_with_metadata.html.erb
-- spec/fixtures/src/layout_with_specific_metadata.html.erb
-- spec/fixtures/src/metadata.yml
-- spec/fixtures/src/with_layout/index.textile
-- spec/fixtures/src/with_layout/index_with_specific_metadata.textile
-- spec/lib/smartgen/configuration_spec.rb
-- spec/lib/smartgen/engines/base_spec.rb
-- spec/lib/smartgen/engines/markdown_spec.rb
-- spec/lib/smartgen/engines/textile_spec.rb
-- spec/lib/smartgen/generator_spec.rb
-- spec/lib/smartgen/indexer_spec.rb
-- spec/lib/smartgen/markup_file_spec.rb
-- spec/lib/smartgen/object_hash_spec.rb
-- spec/lib/smartgen/renderers/erb_spec.rb
-- spec/lib/smartgen/resource_spec.rb
-- spec/lib/smartgen/watcher_spec.rb
-- spec/lib/smartgen_spec.rb
-- spec/sandbox/.gitkeep
-- spec/spec_helper.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -229,7 +183,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -238,7 +191,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -249,41 +201,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A static HTML markup generator
-test_files: 
-- spec/fixtures/expectations/common/another_index.html
-- spec/fixtures/expectations/common/index.html
-- spec/fixtures/expectations/common/other_index.html
-- spec/fixtures/expectations/indexer/index_with_indexer.html
-- spec/fixtures/expectations/indexer/index_with_indexer_and_numbered_index.html
-- spec/fixtures/expectations/with_layout/index.html
-- spec/fixtures/expectations/with_layout/index_with_metadata.html
-- spec/fixtures/expectations/with_layout/index_with_specific_metadata.html
-- spec/fixtures/src/assets/images/image.gif
-- spec/fixtures/src/assets/javascripts/somelib.js
-- spec/fixtures/src/assets/stylesheets/style.css
-- spec/fixtures/src/common/another_index.md
-- spec/fixtures/src/common/index.textile
-- spec/fixtures/src/common/other_index.markdown
-- spec/fixtures/src/common/somefile
-- spec/fixtures/src/indexer/index_with_indexer.textile
-- spec/fixtures/src/indexer/index_with_indexer_and_numbered_index.textile
-- spec/fixtures/src/layout.html.erb
-- spec/fixtures/src/layout_with_metadata.html.erb
-- spec/fixtures/src/layout_with_specific_metadata.html.erb
-- spec/fixtures/src/metadata.yml
-- spec/fixtures/src/with_layout/index.textile
-- spec/fixtures/src/with_layout/index_with_specific_metadata.textile
-- spec/lib/smartgen/configuration_spec.rb
-- spec/lib/smartgen/engines/base_spec.rb
-- spec/lib/smartgen/engines/markdown_spec.rb
-- spec/lib/smartgen/engines/textile_spec.rb
-- spec/lib/smartgen/generator_spec.rb
-- spec/lib/smartgen/indexer_spec.rb
-- spec/lib/smartgen/markup_file_spec.rb
-- spec/lib/smartgen/object_hash_spec.rb
-- spec/lib/smartgen/renderers/erb_spec.rb
-- spec/lib/smartgen/resource_spec.rb
-- spec/lib/smartgen/watcher_spec.rb
-- spec/lib/smartgen_spec.rb
-- spec/sandbox/.gitkeep
-- spec/spec_helper.rb
+test_files: []
+