RubyGems - smartgen - Versions diffs - 0.1.0 - Mend

smartgen 0.1.0

Files changed (50) hide show

data/ChangeLog.md +4 -0
data/Gemfile +11 -0
data/Gemfile.lock +61 -0
data/README.md +119 -0
data/Rakefile +8 -0
data/bin/smartgen +25 -0
data/lib/smartgen.rb +21 -0
data/lib/smartgen/configuration.rb +17 -0
data/lib/smartgen/engines.rb +3 -0
data/lib/smartgen/engines/base.rb +45 -0
data/lib/smartgen/engines/markdown.rb +16 -0
data/lib/smartgen/engines/textile.rb +16 -0
data/lib/smartgen/generator.rb +104 -0
data/lib/smartgen/markup_file.rb +47 -0
data/lib/smartgen/object_hash.rb +41 -0
data/lib/smartgen/renderers.rb +1 -0
data/lib/smartgen/renderers/erb.rb +12 -0
data/lib/smartgen/resource.rb +32 -0
data/lib/smartgen/version.rb +4 -0
data/spec/fixtures/expectations/common/another_index.html +13 -0
data/spec/fixtures/expectations/common/index.html +8 -0
data/spec/fixtures/expectations/common/other_index.html +13 -0
data/spec/fixtures/expectations/with_layout/index.html +12 -0
data/spec/fixtures/expectations/with_layout/index_with_metadata.html +43 -0
data/spec/fixtures/expectations/with_layout/index_with_specific_metadata.html +44 -0
data/spec/fixtures/src/assets/images/image.gif +0 -0
data/spec/fixtures/src/assets/javascripts/somelib.js +2 -0
data/spec/fixtures/src/assets/stylesheets/style.css +2 -0
data/spec/fixtures/src/common/another_index.md +12 -0
data/spec/fixtures/src/common/index.textile +10 -0
data/spec/fixtures/src/common/other_index.markdown +12 -0
data/spec/fixtures/src/layout.html.erb +5 -0
data/spec/fixtures/src/layout_with_metadata.html.erb +22 -0
data/spec/fixtures/src/layout_with_specific_metadata.html.erb +23 -0
data/spec/fixtures/src/metadata.yml +43 -0
data/spec/fixtures/src/with_layout/index.textile +10 -0
data/spec/fixtures/src/with_layout/index_with_specific_metadata.textile +10 -0
data/spec/lib/smartgen/configuration_spec.rb +30 -0
data/spec/lib/smartgen/engines/base_spec.rb +71 -0
data/spec/lib/smartgen/engines/markdown_spec.rb +23 -0
data/spec/lib/smartgen/engines/textile_spec.rb +19 -0
data/spec/lib/smartgen/generator_spec.rb +166 -0
data/spec/lib/smartgen/markup_file_spec.rb +128 -0
data/spec/lib/smartgen/object_hash_spec.rb +54 -0
data/spec/lib/smartgen/renderers/erb_spec.rb +32 -0
data/spec/lib/smartgen/resource_spec.rb +60 -0
data/spec/lib/smartgen_spec.rb +18 -0
data/spec/sandbox/.gitkeep +0 -0
data/spec/spec_helper.rb +37 -0
metadata +240 -0

data/ChangeLog.md ADDED Viewed

@@ -0,0 +1,4 @@
+0.1.0
+-----
+* First release

data/Gemfile ADDED Viewed

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+gemspec
+platforms :mri_18 do
+  gem "ruby-debug"
+end
+platforms :mri_19 do
+  gem "ruby-debug19" if RUBY_VERSION < "1.9.3"
+end

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    smartgen (0.0.1)
+      RedCloth (>= 4.2.3)
+      activesupport (>= 2.3.5)
+      bluecloth (>= 2.0.9)
+      i18n (>= 0.5.0)
+      thor (>= 0.14.6)
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    activesupport (2.3.5)
+    archive-tar-minitar (0.5.2)
+    bluecloth (2.0.9)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    linecache (0.43)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    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)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    thor (0.14.6)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  RedCloth (>= 4.2.3)
+  activesupport (>= 2.3.5)
+  bluecloth (>= 2.0.9)
+  i18n (>= 0.5.0)
+  rspec (>= 2.3.0)
+  ruby-debug
+  ruby-debug19
+  smartgen!
+  thor (>= 0.14.6)

data/README.md ADDED Viewed

@@ -0,0 +1,119 @@
+Smartgen
+========
+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:
+    gem 'smartgen'
+Then you can create a resource configuration:
+    Smartgen[:my_doc].configure do |config|
+      config.src_files = ['doc/**/*']
+      config.output_folder = 'public/docs'
+    end
+Finally you generate it:
+    Smartgen[:my_doc].generate!
+## 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:
+    Smartgen[:my_doc].configure do |config|
+      config.src_files = ['doc/**/*']
+      config.output_folder = 'public/docs'
+      config.layout = 'doc/layout.html.erb'
+    end
+This layout file is an ERB template, that has some methods available, for example this would be a basic layout:
+    <html>
+    <body>
+      <%= markup_file.contents %>
+    </body>
+    </html>
+## Using metadata in layout
+You can specify a metadata file and use it in layouts:
+    Smartgen[:my_doc].configure do |config|
+      config.src_files = ['doc/**/*']
+      config.output_folder = 'public/docs'
+      config.layout = 'doc/layout.html.erb'
+      config.metadata_file = 'doc/metadata.yml'
+    end
+This would be `doc/metadata.yml` contents
+    title: Common title
+    pages:
+      - &index
+        file: index
+        title: Index Page
+        description: Description for index page
+      - &some_page
+        file: some_page
+        title: Some Page
+        description: Description for some page
+    menu: [*index, *some_page]
+And this could be a layout that makes use of these metadata:
+    <html>
+    <head>
+      <title><% metadata.current_page.title %> :: <%= metadata.title %></title>
+    </head>
+    <body>
+      <section id="menu">
+        <ul>
+          <% metadata.menu.each do |entry| %>
+            <lu><a href="<%= entry.file %>.html" title="<%= entry.description %>"><%= entry.title %></a></li>
+          <% end %>
+        </ul>
+      </section>
+      <section id="contents">
+        <%= markup_file.contents %>
+      </section>
+    </body>
+    </html>
+As you can see, there is a special metadata method called `current_page`. This is created whenever you declare a pages section in your metadata file with a `file` key that matches the current file being processed. This way you can use this to put specific file metadata when rendering layouts.
+## 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:
+    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}']
+    end
+As you can see you can pass an array of `Dir.glob` to either assets or src_files configuration.
+## 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`:
+    Smartgen[:doc].configure do |config|
+      config.src_files = ['doc/**/*']
+      config.output_folder = 'public/docs'
+      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'
+      config.layout = 'other_layout.html.erb'
+    end
+    Smartgen[:doc].generate!
+    Smartgen[:some_other_documentation].generate!

data/Rakefile ADDED Viewed

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require "rspec/core/rake_task"
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)

data/bin/smartgen ADDED Viewed

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+begin
+  require 'smartgen/autorun'
+rescue LoadError
+  $stderr.puts <<-EOS
+#{'*'*50}
+  Could not find 'smartgen/autorun'
+  This may happen if you're using rubygems as your package manager, but it is not
+  being required through some mechanism before executing the rspec command.
+  You may need to do one of the following in your shell:
+    # for bash/zsh
+    export RUBYOPT=rubygems
+    # for csh, etc.
+    set RUBYOPT=rubygems
+  For background, please see http://gist.github.com/54177.
+#{'*'*50}
+  EOS
+  exit(1)
+end

data/lib/smartgen.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+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', '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__))
+module Smartgen
+  class << self
+    def [](name)
+      resources[name] ||= Smartgen::Resource.new
+    end
+    private
+      def resources
+        @resources ||= {}
+      end
+  end
+end

data/lib/smartgen/configuration.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module Smartgen
+  class Configuration
+    attr_accessor :src_files
+    attr_accessor :output_folder
+    attr_accessor :layout
+    attr_accessor :assets
+    attr_accessor :metadata_file
+    def initialize
+      @src_files = []
+      @output_folder = 'tmp'
+      @layout = nil
+      @assets = []
+      @metadata_file = 'metadata.yml'
+    end
+  end
+end

data/lib/smartgen/engines.rb ADDED Viewed

@@ -0,0 +1,3 @@
+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__))

data/lib/smartgen/engines/base.rb ADDED Viewed

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/class/inheritable_attributes'
+require 'active_support/core_ext/try'
+module Smartgen
+  module Engine
+    class Base
+      class_inheritable_accessor :pre_processors
+      def initialize
+        self.pre_processors ||= []
+      end
+      def process(body)
+        parse(pre_process(body))
+      end
+      def supported?(extension)
+        extensions.include?(extension)
+      end
+      class << self
+        def register(processor)
+          self.pre_processors ||= []
+          self.pre_processors << processor
+        end
+      end
+      protected
+        def pre_process(body)
+          self.pre_processors.inject(body) do |processed_body, pre_processor|
+            processed_body = pre_processor.process(processed_body)
+            processed_body
+          end
+        end
+        def parse(body)
+          body
+        end
+        def extensions
+          []
+        end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'bluecloth'
+module Smartgen
+  module Engine
+    class Markdown < Base
+      protected
+        def parse(body)
+          BlueCloth.new(body).to_html
+        end
+        def extensions
+          @extensions ||= ['.md', '.markdown']
+        end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'RedCloth'
+module Smartgen
+  module Engine
+    class Textile < Base
+      protected
+        def parse(body)
+          RedCloth.new(body).to_html
+        end
+        def extensions
+          @extensions ||= ['.textile']
+        end
+    end
+  end
+end

data/lib/smartgen/generator.rb ADDED Viewed

@@ -0,0 +1,104 @@
+require 'thor/group'
+module Smartgen
+  class Generator < Thor::Group
+    include Thor::Actions
+    argument :src_files, :type => :array
+    argument :output_folder, :type => :string
+    class_option :layout, :type => :string
+    class_option :assets, :type => :array, :default => []
+    class_option :metadata_file, :type => :string
+    attr_reader :loaded_files
+    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
+      def renderer
+        @renderer ||= Smartgen::Renderer::ERB.new
+      end
+      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))
+        else
+          markup_file.contents
+        end
+      end
+      def has_layout?
+        options.has_key?("layout")
+      end
+      def layout
+        File.read(options["layout"])
+      end
+      def metadata_for(markup_file)
+        metadata = load_metadata
+        add_current_page_data_to(metadata, markup_file)
+        metadata
+      end
+      def load_metadata
+        if options["metadata_file"]
+          YAML.load(File.read(options["metadata_file"]))
+        else
+          {}
+        end
+      end
+      def add_current_page_data_to(metadata, markup_file)
+        if metadata.has_key?("pages")
+          metadata["current_page"] = page_metadata(metadata, markup_file) || {}
+        end
+      end
+      def page_metadata(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
+        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