RubyGems - smartgen - Versions diffs - 0.1.2 → 0.2.0 - Mend

smartgen 0.1.2 → 0.2.0

Files changed (27) hide show

data/ChangeLog.md +14 -0
data/Gemfile.lock +4 -1
data/README.md +21 -10
data/lib/smartgen.rb +3 -0
data/lib/smartgen/configuration.rb +52 -0
data/lib/smartgen/engines/base.rb +7 -0
data/lib/smartgen/engines/markdown.rb +1 -0
data/lib/smartgen/engines/textile.rb +1 -0
data/lib/smartgen/generator.rb +25 -2
data/lib/smartgen/indexer.rb +162 -0
data/lib/smartgen/markup_file.rb +50 -7
data/lib/smartgen/object_hash.rb +9 -2
data/lib/smartgen/rake_task.rb +15 -0
data/lib/smartgen/renderers/erb.rb +4 -0
data/lib/smartgen/resource.rb +17 -0
data/lib/smartgen/version.rb +1 -1
data/spec/fixtures/expectations/indexer/index_with_indexer.html +16 -0
data/spec/fixtures/expectations/indexer/index_with_indexer_and_numbered_index.html +16 -0
data/spec/fixtures/src/common/somefile +10 -0
data/spec/fixtures/src/indexer/index_with_indexer.textile +26 -0
data/spec/fixtures/src/indexer/index_with_indexer_and_numbered_index.textile +26 -0
data/spec/lib/smartgen/configuration_spec.rb +8 -0
data/spec/lib/smartgen/generator_spec.rb +48 -1
data/spec/lib/smartgen/indexer_spec.rb +122 -0
data/spec/lib/smartgen/markup_file_spec.rb +21 -1
data/spec/lib/smartgen/object_hash_spec.rb +11 -1
metadata +35 -6

data/ChangeLog.md CHANGED Viewed

@@ -1,3 +1,17 @@
+0.2.0
+-----
+* Fixed README to explain that only directories may be specified in assets config
+* Added support for a table of contents of every generated page
+* ObjectHash will output a warning instead of raising error when a missing key accessor method is called.
+* Added documentation for classes and some improvements in README
+0.1.3
+-----
+* Bug Fix: Error when declareted file not exists
+* Bug Fix: Error when metadata not exists
 0.1.2
 -----

data/Gemfile.lock CHANGED Viewed

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    smartgen (0.1.1)
+    smartgen (0.1.2)
       RedCloth (>= 4.2.3)
       activesupport (>= 2.3.5)
       bluecloth (>= 2.0.9)
       i18n (>= 0.5.0)
+      nokogiri (>= 1.4.4)
       thor (>= 0.14.6)
 GEM
@@ -21,6 +22,7 @@ GEM
     linecache (0.43)
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
+    nokogiri (1.4.4)
     rake (0.8.7)
     rspec (2.3.0)
       rspec-core (~> 2.3.0)
@@ -55,6 +57,7 @@ DEPENDENCIES
   activesupport (>= 2.3.5)
   bluecloth (>= 2.0.9)
   i18n (>= 0.5.0)
+  nokogiri (>= 1.4.4)
   rake (= 0.8.7)
   rspec (>= 2.3.0)
   ruby-debug

data/README.md CHANGED Viewed

@@ -1,15 +1,15 @@
 Smartgen
 ========
-Smartgen generates static HTML files from markup files, using textile or markdown, and ERB to create layout templates.
+Smartgen generates static HTML files from markup files, using textile or markdown and ERB to create layout templates.
 ## Basic Usage
-To use you must first add the gem to your Gemfile:
+To use it, you must first add the gem to your Gemfile:
     gem 'smartgen'
-Then you can create a resource configuration:
+Then, create a resource configuration:
     Smartgen[:my_doc].configure do |config|
       config.src_files = ['doc/**/*']
@@ -22,7 +22,7 @@ Finally you generate it:
 ## Adding a layout
-By default Smartgen will only parse your textile (*.textile) or markdown (*.md or *.markdown) files, based on their extension and output it. You can give a layout file that will be used when rendering each file:
+By default Smartgen will only parse your textile (*.textile) or markdown (*.md or *.markdown) files, based on their extension and output it. You can setup a layout file that will be used when rendering each file:
     Smartgen[:my_doc].configure do |config|
       config.src_files = ['doc/**/*']
@@ -63,7 +63,7 @@ This would be `doc/metadata.yml` contents
         description: Description for some page
     menu: [*index, *some_page]
-And this could be a layout that makes use of these metadata:
+And this could be a layout that makes use of the metadata above:
     <html>
     <head>
@@ -88,19 +88,19 @@ As you can see, there is a special metadata method called `current_page`. This i
 ## Copying assets
-When you generate documentation with Smartgen you'll often need to also copy stylesheets, javascript files and images to the output folder. You can easily do so by specifying an array of assets when configuring:
+When you generate documentation with Smartgen you'll often need to also copy stylesheets, javascript files and images to the output folder. You can easily do so by specifying an array of dirs to copy when configuring:
     Smartgen[:my_doc].configure do |config|
       config.src_files = ['doc/**/*']
       config.output_folder = 'public/docs'
-      config.assets = ['doc/stylesheets/*.css', 'doc/javascripts/*.js', 'doc/images/*.{png|jpg|gif}']
+      config.assets = ['doc/stylesheets', 'doc/javascripts', 'doc/images']
     end
-As you can see you can pass an array of `Dir.glob` to either assets or src_files configuration.
+Only directories may be specified. Smartgen will copy the contents of each directory to the output folder, preserving the directory itself. So `doc/stylesheets` will be copied to `public/docs/stylesheets` for example.
 ## Using different configurations
-You may create as many resource configurations as you want. You create a configuration the first time you call `Smartgen[:some_config_name]`, and then, whenever you use it again it will return that configuration. You can change the configuration by calling `configure`:
+You may create as many resource configurations as you want. When you call `Smartgen[:some_config_name]`, Smartgen creates a configuration with name `:some_config_name` and then, whenever you use it again, Smartgen returns that configuration. You can even change the configuration by calling `configure`:
     Smartgen[:doc].configure do |config|
       config.src_files = ['doc/**/*']
@@ -129,4 +129,15 @@ You may also use a rake task:
       config.output_folder = 'public/docs'
     end
-The yielded config is exactly the same config yielded by Smartgen::Resource#configure method, so you can use any of the above configs.
+The yielded config is exactly the same config yielded by Smartgen::Resource#configure method, so you can use any of the above configs.
+## Contributors
+* [Vicente Mundim](http://github.com/vicentemundim) _author_
+* [Emerson Leite](http://github.com/emerleite)
+* [Rodrigo Lopes](http://github.com/rodvlopes)
+* [Marcos Silva Pereira](http://github.com/marcospereira)
+## Copyright
+Copyright (c) 2011 Vicente Mundim. See LICENSE for details.

data/lib/smartgen.rb CHANGED Viewed

@@ -2,13 +2,16 @@
 require File.expand_path(File.join('smartgen', 'object_hash'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'resource'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'configuration'), File.dirname(__FILE__))
+require File.expand_path(File.join('smartgen', 'indexer'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'markup_file'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'renderers'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'engines'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'generator'), File.dirname(__FILE__))
+# Smartgen generates HTML files from markup files, possibly using layouts.
 module Smartgen
   class << self
+    # Returns a resouces with the given name, creating it if necessary.
     def [](name)
       resources[name] ||= Smartgen::Resource.new
     end

data/lib/smartgen/configuration.rb CHANGED Viewed

@@ -1,17 +1,69 @@
 module Smartgen
+  # Holds configurations for each smartgen resource.
   class Configuration
+    # An array with all the source files that should be generated.
+    #
+    # Each entry may be a glob, such as 'doc/**/*'. Only files with extensions
+    # supported by the registered engines will be used. Files without extensions
+    # will be used as well, but they will use the highest priority engine.
+    #
+    # default:
+    #   []
     attr_accessor :src_files
+    # The output folder, where all generated files will be located.
+    #
+    # 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/base.rb CHANGED Viewed

@@ -2,22 +2,29 @@ require 'active_support/core_ext/class/inheritable_attributes'
 module Smartgen
   module Engine
+    # Base class for engines.
+    #
+    # An engine process markup files, converting them to HTML.
     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))
       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)
           self.pre_processors ||= []
           self.pre_processors << processor

data/lib/smartgen/engines/markdown.rb CHANGED Viewed

@@ -2,6 +2,7 @@ require 'bluecloth'
 module Smartgen
   module Engine
+    # Processes markdown files, supporting both '.md' and '.markdown' extensions.
     class Markdown < Base
       protected
         def parse(body)

data/lib/smartgen/engines/textile.rb CHANGED Viewed

@@ -2,6 +2,7 @@ require 'RedCloth'
 module Smartgen
   module Engine
+    # Processes textile files, supporting '.textile' extension.
     class Textile < Base
       protected
         def parse(body)

data/lib/smartgen/generator.rb CHANGED Viewed

@@ -1,17 +1,30 @@
 require 'thor/group'
 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
-    attr_reader :loaded_files
+    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
@@ -32,10 +45,12 @@ module Smartgen
     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
@@ -89,7 +104,15 @@ module Smartgen
       def markup_files
         Dir[*src_files].select { |f| supported?(File.extname(f)) }.map do |markup_filename|
-          MarkupFile.new markup_filename
+          MarkupFile.new markup_filename, markup_file_options
+        end
+      end
+      def markup_file_options
+        if options[:numbered_index]
+          { :indexer => { :numbered_index => true } }
+        else
+          { :indexer => options[:use_indexer] }
         end
       end

data/lib/smartgen/indexer.rb ADDED Viewed

@@ -0,0 +1,162 @@
+require 'nokogiri'
+module Smartgen
+  # Parses the given HTML contents and generates a structure of indexes based
+  # on h1, h2, h3, h4, h5, h6 tags.
+  #
+  # It will also add IDs to each hx tag, based on their content and store this
+  # modified content on #result.
+  #
+  # On #index it will store a hierarchical structure for the h tags it
+  # encounters, with title, id, level, numbered_index and chidren.
+  #
+  # For example, this HTML:
+  #
+  #   <h2>My header</h2>
+  #   <h3>Some minor header</h3>
+  #   <h3>Another minor header</h3>
+  #   <h2>My other header</h2>
+  #   <h3>Some other minor header</h3>
+  #
+  # Will generate this HTML using #result:
+  #
+  #   <h2 id="my-header">My header</h2>
+  #   <h3 id="some-minor-header">Some minor header</h3>
+  #   <h3 id="another-minor-header">Another minor header</h3>
+  #   <h2 id="my-other-header">My other header</h2>
+  #   <h3 id="some-other-minor-header">Some other minor header</h3>
+  #
+  # And this structure in #index:
+  #
+  #   [{
+  #     :level=>2,
+  #     :text=>"My header",
+  #     :id=>"my-header",
+  #     :children=>
+  #       [{:level=>3,
+  #         :text=>"Some minor header",
+  #         :children=>[],
+  #         :id=>"some-minor-header"},
+  #       {:level=>3,
+  #         :text=>"Another minor header",
+  #         :children=>[],
+  #         :id=>"another-minor-header"}],
+  #   },
+  #   {
+  #      :level=>2,
+  #      :text=>"My other header",
+  #      :id=>"my-other-header"
+  #      :children=> [{:level=>3, :text=>"Some other minor header", :children=>[], :id=>"some-other-minor-header"}],
+  #   }]
+  #
+  # If can pass <tt>:numbered_index => true</tt> in the options, and it will add
+  # a numbered index on each title and add a +:numbered_index+ key with its value
+  # on each node in the hash generated by #index.
+  class Indexer
+    attr_accessor :index, :result
+    def initialize(contents, options={})
+      @contents = contents
+      @result = @contents.dup
+      @options = options.is_a?(Hash) ? options : {}
+      @index = []
+      parse
+    end
+    private
+      def parse
+        current_level = 0
+        parent = nil
+        Nokogiri::HTML(@result).xpath('//h1|//h2|//h3|//h4|//h5|//h6').each do |h_tag|
+          tag_level = tag_level_for(h_tag)
+          if tag_level < current_level
+            parent = parent_with_level(tag_level, parent)
+          elsif tag_level == current_level
+            parent = parent[:parent]
+          end
+          title = h_tag.inner_html
+          update_h_tag(h_tag, parent)
+          parent = add_to(parent, title, tag_level)
+          current_level = tag_level
+        end
+        remove_parents_from(index)
+      end
+      def tag_level_for(h_tag)
+        h_tag.name.sub('h', '').to_i
+      end
+      def add_to(parent, title, tag_level)
+        index_hash(parent, title, tag_level).tap do |child|
+          if parent.nil? # add to index
+            index << child
+          else
+            parent[:children] << child
+          end
+        end
+      end
+      def index_hash(parent, title, tag_level)
+        return {
+          :text => title,
+          :id => title_to_idx(title),
+          :level => tag_level,
+          :parent => parent,
+          :children => []
+        }.merge(numbered_index_data(parent))
+      end
+      def numbered_index_data(parent)
+        if numbered_index?
+          { :numbered_index => numbered_index_for(parent) }
+        else
+          {}
+        end
+      end
+      def numbered_index_for(parent)
+        if parent.nil?
+          "#{index.size + 1}"
+        else
+          "#{parent[:numbered_index]}.#{parent[:children].size + 1}"
+        end
+      end
+      def numbered_index?
+        @options[:numbered_index].present?
+      end
+      def parent_with_level(level, current_parent)
+        while current_parent.present? && current_parent[:level] >= level
+          current_parent = current_parent[:parent]
+        end
+        current_parent
+      end
+      def remove_parents_from(items)
+        items.each do |item|
+          item.delete(:parent)
+          remove_parents_from(item[:children])
+        end
+      end
+      def update_h_tag(h_tag, parent)
+        snippet = h_tag.to_html
+        h_tag['id'] ||= title_to_idx(h_tag.inner_html)
+        h_tag.inner_html = "#{numbered_index_for(parent)} #{h_tag.inner_html}" if numbered_index?
+        @result.sub!(snippet, h_tag.to_html)
+      end
+      def title_to_idx(title)
+        title.strip.downcase.gsub(/\s+|_/, '-').delete('^a-z0-9-')
+      end
+  end
+end

data/lib/smartgen/markup_file.rb CHANGED Viewed

@@ -1,26 +1,66 @@
-require "active_support/inflector"
 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:
+  #
+  #   MarkupFile.new 'some/path', :indexer => { :numbered_index => true }
+  #
   class MarkupFile
-    attr_accessor :path, :filename, :extension, :engine
-    def initialize(path)
+    # 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)
+      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
-    def contents
-      engine.process(raw_contents)
-    end
     class << self
+      # Returns an array with the supported engines.
+      #
+      # The priority of the engines is defined by their order in this array. The
+      # first ones are the ones with higher priority.
       def engines
         if @engines.blank?
           @engines = [Smartgen::Engine::Textile.new, Smartgen::Engine::Markdown.new]
@@ -29,6 +69,9 @@ module Smartgen
         @engines
       end
+      # Register an engine to be used when generating files.
+      #
+      # The engine will be added with the highest priority.
       def register(engine)
         engines.unshift engine.new
       end

data/lib/smartgen/object_hash.rb CHANGED Viewed

@@ -1,6 +1,12 @@
 require 'active_support/core_ext/hash'
 module Smartgen
+  # A hash that has method accessors for each key.
+  #
+  # For example:
+  #   hash = ObjectHash.new({:foo => 'bar'})
+  #   puts hash.foo     # outputs 'bar'
+  #
   class ObjectHash < HashWithIndifferentAccess
     def dup
       Smartgen::ObjectHash.new(self)
@@ -15,7 +21,8 @@ module Smartgen
         if has_key?(name)
           self[name]
         else
-          super
+          puts "warning: key #{name} not found on #{inspect}"
+          Smartgen::ObjectHash.new
         end
       end
@@ -32,7 +39,7 @@ module Smartgen
   end
 end
-class Hash
+class Hash # :nodoc: all
   def with_object_hash
     hash = Smartgen::ObjectHash.new(self)
     hash.default = self.default

data/lib/smartgen/rake_task.rb CHANGED Viewed

@@ -5,6 +5,21 @@ require 'rake/tasklib'
 require 'smartgen'
 module Smartgen
+  # A rake task that generate files using smartgen.
+  #
+  # To use it, require this file instead of +smartgen+:
+  #
+  #   require 'smartgen/rake_task'
+  #
+  # Then create the task and configuration:
+  #
+  #   Smartgen::RakeTask.new :generate_doc do |config|
+  #     config.src_files = ['doc/**/*']
+  #     config.output_folder = 'public/doc'
+  #   end
+  #
+  # It yields a Configuration, in fact it calls Resource#configure, so you
+  # can use any of the configurations here.
   class RakeTask < ::Rake::TaskLib
     def initialize(name=nil, &block)
       name = name || :smartgen

data/lib/smartgen/renderers/erb.rb CHANGED Viewed

@@ -1,6 +1,10 @@
 module Smartgen
   module Renderer
+    # A renderer that uses ERB to render markup files.
     class ERB
+      # Renders the markup file using the given layout.
+      #
+      # It exposes +markup_file+ variable and its +metadata+ to the ERB layout.
       def render(layout, markup_file, metadata={})
         metadata = Smartgen::ObjectHash.new(metadata)

data/lib/smartgen/resource.rb CHANGED Viewed

@@ -1,13 +1,30 @@
 module Smartgen
+  # A Resource holds a Configuration used when generating files.
+  #
+  # You create a resource and configure it like this:
+  #
+  #   Smartgen[:my_resource].configure do |config|
+  #     config.src_files = ['docs/**/*']
+  #     config.output_folder = 'public/docs'
+  #   end
+  #
+  # To generate files, just call Resource#generate! on it:
+  #
+  #   Smartgen[:my_resource].generate!
   class Resource
+    # Yields a Configuration, so that you can configure the generation of files.
     def configure
       yield config
     end
+    # Returns the Configuration for this resource.
     def config
       @config ||= Smartgen::Configuration.new
     end
+    # Generate files, based on the current Configuration.
     def generate!
       generator.invoke_all
     end

data/lib/smartgen/version.rb CHANGED Viewed

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

data/spec/fixtures/expectations/indexer/index_with_indexer.html ADDED Viewed

@@ -0,0 +1,16 @@
+<h1 id="here-is-some-header">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 id="another-header">Another header</h2>
+<p>With some text</p>
+<h3 id="another-minor-header">Another minor header</h3>
+<p>With some other text</p>
+<h4 id="yet-another-smaller-header">Yet another smaller header</h4>
+<p>Again some text</p>
+<h3 id="a-minor-header">A minor header</h3>
+<p>Something</p>
+<h2 id="a-header">A header</h2>
+<p>With something</p>

data/spec/fixtures/expectations/indexer/index_with_indexer_and_numbered_index.html ADDED Viewed

@@ -0,0 +1,16 @@
+<h1 id="here-is-some-header">1 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 id="another-header">1.1 Another header</h2>
+<p>With some text</p>
+<h3 id="another-minor-header">1.1.1 Another minor header</h3>
+<p>With some other text</p>
+<h4 id="yet-another-smaller-header">1.1.1.1 Yet another smaller header</h4>
+<p>Again some text</p>
+<h3 id="a-minor-header">1.1.2 A minor header</h3>
+<p>Something</p>
+<h2 id="a-header">1.2 A header</h2>
+<p>With something</p>

data/spec/fixtures/src/common/somefile ADDED Viewed

@@ -0,0 +1,10 @@
+h1. Here is some header
+And here is a paragraph
+* some bullet lists with *style*
+* some bullet lists with _style_
+h2. Another header
+With some text

data/spec/fixtures/src/indexer/index_with_indexer.textile ADDED Viewed

@@ -0,0 +1,26 @@
+h1. Here is some header
+And here is a paragraph
+* some bullet lists with *style*
+* some bullet lists with _style_
+h2. Another header
+With some text
+h3. Another minor header
+With some other text
+h4. Yet another smaller header
+Again some text
+h3. A minor header
+Something
+h2. A header
+With something

data/spec/fixtures/src/indexer/index_with_indexer_and_numbered_index.textile ADDED Viewed

@@ -0,0 +1,26 @@
+h1. Here is some header
+And here is a paragraph
+* some bullet lists with *style*
+* some bullet lists with _style_
+h2. Another header
+With some text
+h3. Another minor header
+With some other text
+h4. Yet another smaller header
+Again some text
+h3. A minor header
+Something
+h2. A header
+With something

data/spec/lib/smartgen/configuration_spec.rb CHANGED Viewed

@@ -26,5 +26,13 @@ describe Smartgen::Configuration do
     it "should initialize metadata_file to nil" do
       subject.metadata_file.should be_nil
     end
+    it "should initialize use_indexer to false" do
+      subject.use_indexer.should be_false
+    end
+    it "should initialize numbered_index to false" do
+      subject.numbered_index.should be_false
+    end
   end
 end

data/spec/lib/smartgen/generator_spec.rb CHANGED Viewed

@@ -85,6 +85,17 @@ describe Smartgen::Generator do
       end
     end
+    describe "inexistent file" do
+      def src_files
+        [fixture('src/common/inexistent_file.textile')]
+      end
+      it "should not generate html" do
+        subject.invoke_all
+        File.should_not be_file(output_folder_file("inexistent_file.html"))
+      end
+    end
     describe "with layout" do
       def src_files
         [fixture('src/with_layout/index.textile')]
@@ -158,6 +169,42 @@ describe Smartgen::Generator do
         read_output('javascripts/somelib.js').should == read_fixture('src/assets/javascripts/somelib.js')
       end
     end
+    describe "with indexer" do
+      def src_files
+        [fixture('src/indexer/index_with_indexer.textile')]
+      end
+      def options
+        { :use_indexer => true }
+      end
+      it "should add IDs to each <h> tag" do
+        capture(:stdout) { subject.invoke_all }
+        actual_src_filenames.each do |src_filename, src_ext|
+          read_output("#{src_filename}.html").should == read_fixture("expectations/indexer/#{src_filename}.html")
+        end
+      end
+      context "and numbered_index" do
+        def src_files
+          [fixture('src/indexer/index_with_indexer_and_numbered_index.textile')]
+        end
+        def options
+          { :use_indexer => true, :numbered_index => true }
+        end
+        it "should add numbered indexes on each <h> tag" do
+          capture(:stdout) { subject.invoke_all }
+          actual_src_filenames.each do |src_filename, src_ext|
+            read_output("#{src_filename}.html").should == read_fixture("expectations/indexer/#{src_filename}.html")
+          end
+        end
+      end
+    end
   end
   describe "renderer registration" do
@@ -176,4 +223,4 @@ describe Smartgen::Generator do
       Smartgen::Generator.renderer.render('some_layout', mock(Smartgen::MarkupFile)).should == "do some rendering stuff"
     end
   end
-end
+end

data/spec/lib/smartgen/indexer_spec.rb ADDED Viewed

@@ -0,0 +1,122 @@
+require 'spec_helper'
+describe Smartgen::Indexer do
+  matcher :have_tag do |tag, attributes|
+    match do |actual|
+      tags = Nokogiri::HTML(actual).css(tag.to_s)
+      tags.present? && tags.any? do |tag|
+        attributes.all? do |attribute, value|
+          tag.has_attribute?(attribute.to_s) && tag[attribute.to_s] == value
+        end
+      end
+    end
+  end
+  matcher :have_tag_with_contents do |tag, content|
+    match do |actual|
+      tags = Nokogiri::HTML(actual).css(tag.to_s)
+      tags.present? && tags.any? do |tag|
+        tag.content == content
+      end
+    end
+  end
+  def html
+    "<h1>Some header</h1>"
+  end
+  subject { Smartgen::Indexer.new html }
+  describe "addition of IDs" do
+    def html
+      return <<-HTML
+<html>
+<body>
+  <h1>A h1 header</h1>
+  <h2>A h2 header</h2>
+  <h3>A h3 header</h3>
+  <h4>A h4 header</h4>
+  <h5>A h5 header</h5>
+  <h6>A h6 header</h6>
+</body>
+</html>
+  HTML
+    end
+    1.upto(6).each do |header_level|
+      it "should add IDs for each <h#{header_level}> tag in the result" do
+        subject.result.should have_tag("h#{header_level}", :id => "a-h#{header_level}-header")
+      end
+    end
+  end
+  describe "index" do
+    def html
+      return <<-HTML
+<html>
+<body>
+  <h1>A h1 header</h1>
+  <h2>A h2 header</h2>
+  <h3>A h3 header</h3>
+  <h3>Some other h3 header</h3>
+  <h2>Another h2 header</h2>
+  <h5>A h5 header</h5>
+  <h2>Yet Another h2 header</h2>
+  <h3>Yet Another h3 header</h3>
+  <h1>Other h1 header</h1>
+</body>
+</html>
+  HTML
+    end
+    it "should return an index with headers data hierarquically distributed" do
+      expected_index = [
+        { :text => 'A h1 header', :id => 'a-h1-header', :level => 1, :children => [
+          { :text => 'A h2 header', :id => 'a-h2-header', :level => 2, :children => [
+            { :text => 'A h3 header', :id => 'a-h3-header', :level => 3, :children => [] },
+            { :text => 'Some other h3 header', :id => 'some-other-h3-header', :level => 3, :children => [] }
+          ] },
+          { :text => 'Another h2 header', :id => 'another-h2-header', :level => 2, :children => [
+            { :text => 'A h5 header', :id => 'a-h5-header', :level => 5, :children => [] }
+          ] },
+          { :text => 'Yet Another h2 header', :id => 'yet-another-h2-header', :level => 2, :children => [
+            { :text => 'Yet Another h3 header', :id => 'yet-another-h3-header', :level => 3, :children => [] }
+          ] },
+        ]},
+        { :text => 'Other h1 header', :id => 'other-h1-header', :level => 1, :children => [] }
+      ]
+      subject.index.should == expected_index
+    end
+    context "when numbered_index options is given" do
+      subject { Smartgen::Indexer.new html, :numbered_index => true }
+      it "should add the numbered index to header contents" do
+        subject.result.should have_tag_with_contents("h1", "1 A h1 header")
+        subject.result.should have_tag_with_contents("h2", "1.1 A h2 header")
+        subject.result.should have_tag_with_contents("h3", "1.1.2 Some other h3 header")
+      end
+      it "should return an index with headers data hierarquically distributed with numbered index" do
+        expected_index = [
+          { :text => 'A h1 header', :id => 'a-h1-header', :level => 1, :numbered_index => '1', :children => [
+            { :text => 'A h2 header', :id => 'a-h2-header', :level => 2, :numbered_index => '1.1', :children => [
+              { :text => 'A h3 header', :id => 'a-h3-header', :level => 3, :numbered_index => '1.1.1', :children => [] },
+              { :text => 'Some other h3 header', :id => 'some-other-h3-header', :level => 3, :numbered_index => '1.1.2', :children => [] }
+            ] },
+            { :text => 'Another h2 header', :id => 'another-h2-header', :level => 2, :numbered_index => '1.2', :children => [
+              { :text => 'A h5 header', :id => 'a-h5-header', :level => 5, :numbered_index => '1.2.1', :children => [] }
+            ] },
+            { :text => 'Yet Another h2 header', :id => 'yet-another-h2-header', :level => 2, :numbered_index => '1.3', :children => [
+              { :text => 'Yet Another h3 header', :id => 'yet-another-h3-header', :level => 3, :numbered_index => '1.3.1', :children => [] }
+            ] },
+          ]},
+          { :text => 'Other h1 header', :id => 'other-h1-header', :level => 1, :numbered_index => '2', :children => [] }
+        ]
+        subject.index.should == expected_index
+      end
+    end
+  end
+end

data/spec/lib/smartgen/markup_file_spec.rb CHANGED Viewed

@@ -118,11 +118,31 @@ describe Smartgen::MarkupFile do
       it "should use textile as markup engine for files with .md" do
         def path
-          fixture('src/common/other_index.md')
+          fixture('src/common/another_index.md')
         end
         subject.engine.should be_an_instance_of(Smartgen::Engine::Markdown)
       end
     end
   end
+  describe "indexer" do
+    subject { Smartgen::MarkupFile.new path, :indexer => true }
+    it "should be accessible when using indexer" do
+      subject.indexer.should be_an_instance_of(Smartgen::Indexer)
+    end
+    it "should use indexer" do
+      mock_indexer = mock(Smartgen::Indexer, :result => 'result')
+      Smartgen::Indexer.should_receive(:new).and_return(mock_indexer)
+      subject
+    end
+    it "should return indexer result as contents" do
+      mock_indexer = mock(Smartgen::Indexer, :result => 'result')
+      Smartgen::Indexer.should_receive(:new).and_return(mock_indexer)
+      subject.contents.should == 'result'
+    end
+  end
 end

data/spec/lib/smartgen/object_hash_spec.rb CHANGED Viewed

@@ -14,7 +14,17 @@ describe Smartgen::ObjectHash do
       should respond_to(key)
     end
   end
+  describe "inexistent key" do
+    it "should not respond to" do
+      subject.should_not respond_to("invalid_key")
+    end
+    it "should return an empty ObjectHash" do
+      subject.invalid_key.should be_an_instance_of(Smartgen::ObjectHash)
+    end
+  end
   it "should respond to ancestor methods" do
     ancestor = Smartgen::ObjectHash.ancestors.first
     ancestor.instance_methods.each do |method|

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: smartgen
 version: !ruby/object:Gem::Version
-  hash: 31
+  hash: 23
   prerelease: false
   segments:
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vicente Mundim
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-01-25 00:00:00 -02:00
+date: 2011-01-27 00:00:00 -02:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -99,9 +99,25 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: nokogiri
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 15
+        segments:
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ">="
@@ -113,7 +129,7 @@ dependencies:
         - 0
         version: 2.3.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 description: Smartgen generates static HTML files from markup files, using textile or markdown, and ERB to create layout templates
 email:
 - vicente.mundim@gmail.com
@@ -130,6 +146,7 @@ files:
 - lib/smartgen/engines/textile.rb
 - lib/smartgen/engines.rb
 - lib/smartgen/generator.rb
+- lib/smartgen/indexer.rb
 - lib/smartgen/markup_file.rb
 - lib/smartgen/object_hash.rb
 - lib/smartgen/rake_task.rb
@@ -146,6 +163,8 @@ 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
@@ -155,6 +174,9 @@ files:
 - 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
@@ -166,6 +188,7 @@ files:
 - 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
@@ -211,6 +234,8 @@ 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
@@ -220,6 +245,9 @@ test_files:
 - 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
@@ -231,6 +259,7 @@ test_files:
 - 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