guides 0.6.10 → 0.7.0

data/Gemfile

@@ -1,9 +1,3 @@
 source "http://rubygems.org"
 
 gemspec
-
-group :development do
-  gem "rspec", "~> 2.0"
-  gem "faraday", "~> 0.5.0"
-  gem "packager"
-end

data/guides.gemspec

@@ -4,6 +4,9 @@ $:.unshift lib unless $:.include?(lib)
 
 require 'guides/version'
 
+os = Gem::Platform.local.os
+is_mingw = (os == "mingw32")
+
 Gem::Specification.new do |s|
   s.name        = "guides"
   s.version     = Guides::VERSION
@@ -20,11 +23,19 @@ Gem::Specification.new do |s|
   s.add_dependency "actionpack", "~> 3.0.0"
   s.add_dependency "activesupport", "~> 3.0.0"
   s.add_dependency "rack", "~> 1.2.1"
-  s.add_dependency "RedCloth", "~> 4.1.1"
+  s.add_dependency "RedCloth", "~> 4.2.7"
   s.add_dependency "maruku", "~> 0.6.0"
   s.add_dependency "thor", "~> 0.14.6"
   s.add_dependency "thin", "~> 1.2.7"
 
+  if is_mingw
+    s.add_dependency 'eventmachine', '~> 1.0.0.beta'
+  end
+
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency "faraday", "~> 0.5.0"
+  s.add_development_dependency 'packager'
+
   s.files              = `git ls-files`.split("\n")
   s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables        = %w(guides)

data/lib/guides.rb

@@ -33,5 +33,9 @@ module Guides
         end
       end
     end
+
+    def config(reload = false)
+      meta(reload)['config'] || {}
+    end
   end
 end

data/lib/guides/cli.rb

@@ -21,6 +21,7 @@ module Guides
     desc "build", "build the guides output"
     method_option "only", :type => :array
     method_option "clean", :type => :boolean
+    method_option "edge", :type => :boolean, :default => false
     method_option "production", :type => :boolean, :default => true, :banner => "use production mode", :aliases => "-p"
     def build
       if options[:clean]

data/lib/guides/helpers.rb

@@ -58,18 +58,28 @@ module Guides
       content_tag(:code, c)
     end
 
-    def guide_link(guide)
+    def guide_exists?(guide)
       # Might be able to use build in view_paths methods but I couldn't figure them out - PW
-      exists = view_paths.any? do |p|
+      view_paths.any? do |p|
         Guides::Generator::EXTENSIONS.any?{|e| File.exist? "#{p}/#{guide["url"]}.#{e}" }
       end
+    end
 
-      if exists
+    def guide_link(guide)
+      if guide_exists?(guide)
         link_to guide["title"], "#{guide["url"]}.html"
       else
         guide["title"]
       end
     end
+
+    def guide_chapter_link(guide, chapter)
+      if guide_exists?(guide)
+        anchor = chapter.gsub(/\s/, '-').downcase
+        link_to(chapter, "#{guide["url"]}.html##{anchor}")
+      else
+        chapter
+      end
+    end
   end
 end
-

data/lib/guides/indexer.rb

@@ -30,20 +30,29 @@ module Guides
       level_hash = ActiveSupport::OrderedHash.new
 
       while s.scan_until(%r{^h(\d)(?:\((#.*?)\))?\s*\.\s*(.*)$})
-        level, idx, title = s[1].to_i, s[2], s[3].strip
+        level, element_id, title = s[1].to_i, s[2], s[3].strip
 
         if level < current_level
           # This is needed. Go figure.
           return level_hash
         elsif level == current_level
-          index = counters.join(".")
-          idx ||= '#' + title_to_idx(title)
+          index = counters.dup
+          if format = Guides.config['index_format']
+            index[0] = sprintf(format, index[0])
+          end
+          index = index.join('.')
 
-          raise "Parsing Fail" unless @result.sub!(s.matched, "h#{level}(#{idx}). #{index} #{title}")
+          element_id ||= '#' + title_to_element_id(title)
+
+          header_html = Guides.config['index_header'] || "{{index}} {{title}}"
+          values = { 'index' => index, 'title' => title }
+          header = header_html.gsub(/{{(.*?)}}/){ values[$1].to_str }
+
+          raise "Parsing Fail" unless @result.sub!(s.matched, "h#{level}(#{element_id}). #{header}")
 
           key = {
             :title => title,
-            :id => idx
+            :id => element_id
           }
           # Recurse
           counters << 1
@@ -58,12 +67,12 @@ module Guides
       level_hash
     end
 
-    def title_to_idx(title)
-      idx = title.strip.parameterize.sub(/^\d+/, '')
-      if warnings && idx.blank?
+    def title_to_element_id(title)
+      element_id = title.strip.parameterize.sub(/^\d+/, '')
+      if warnings && element_id.blank?
         puts "BLANK ID: please put an explicit ID for section #{title}, as in h5(#my-id)"
       end
-      idx
+      element_id
     end
   end
 end

data/lib/guides/version.rb

@@ -1,3 +1,3 @@
 module Guides
-  VERSION = "0.6.10"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,104 +1,135 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: guides
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.7.0
   prerelease: 
-  version: 0.6.10
 platform: ruby
-authors: 
+authors:
 - Yehuda Katz
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: actionpack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70106296837060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70106296837060
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70106296836600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rack
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70106296836600
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70106296836140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.2.1
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: RedCloth
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70106296836140
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: &70106296835680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 4.1.1
+      - !ruby/object:Gem::Version
+        version: 4.2.7
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: maruku
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70106296835680
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: &70106296835220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: thor
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70106296835220
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70106296834760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.14.6
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: thin
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70106296834760
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &70106296834300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.2.7
   type: :runtime
-  version_requirements: *id007
-description: A tool for creating version controlled guides for open source projects, based on the Rails Guides framework
-email: 
+  prerelease: false
+  version_requirements: *70106296834300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70106296833840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70106296833840
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70106296833380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *70106296833380
+- !ruby/object:Gem::Dependency
+  name: packager
+  requirement: &70106296833000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70106296833000
+description: A tool for creating version controlled guides for open source projects,
+  based on the Rails Guides framework
+email:
 - wycats@gmail.com
-executables: 
+executables:
 - guides
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Rakefile
@@ -233,32 +264,29 @@ files:
 - spec/textile_transformer_spec.rb
 homepage: http://yehudakatz.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: guides
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Extracting the Rails Guides framework for the rest of us
-test_files: 
+test_files:
 - spec/build_spec.rb
 - spec/fixtures/guides.yml
 - spec/fixtures/source/article_four.textile