Class: SdocAll::Rails

Inherits:
Base
  • Object
show all
Defined in:
lib/sdoc_all/parts/rails.rb

Constant Summary

Constants inherited from Base

Base::BASE_PATH, Base::DOCS_PATH, Base::PUBLIC_PATH

Instance Attribute Summary

Attributes inherited from Base

#config

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

add_merge_task, add_task, base_path, chdir, clear, dirs, docs_path, dry_run!, dry_run?, entries, inherited, output_for_verbose_level, public_path, remove_if_present, short_name, sources_path, subclasses, system, tasks, to_document, used_sources, verbose_level, verbose_level=, with_env

Constructor Details

#initialize(raw_config) ⇒ Rails

Returns a new instance of Rails.



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/sdoc_all/parts/rails.rb', line 3

def initialize(raw_config)
  raw_config ||= {}
  raw_config = {:version => raw_config} unless raw_config.is_a?(Hash)

  if raw_config[:version]
    unless self.class.versions.include?(raw_config[:version])
      raise ConfigError.new("you don't have rails #{raw_config[:version]} installed")
    end
  else
    if self.class.versions.empty?
      raise ConfigError.new("you don't have any rails versions installed")
    end
  end

  @config = {
    :version => raw_config.delete(:version) || self.class.versions.last,
  }

  raise_unknown_options_if_not_blank!(raw_config)
end

Class Method Details

.versions ⇒ Object 



60
61
62
63
64
65
66
 
# File 'lib/sdoc_all/parts/rails.rb', line 60

def versions
  [].tap do |versions|
    Gem.source_index.search(Gem::Dependency.new('rails')).each do |spec|
      versions << spec.version
    end
  end.sort.map(&:to_s)
end

Instance Method Details

#add_tasks(options = {}) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/sdoc_all/parts/rails.rb', line 24

def add_tasks(options = {})
  version = config[:version]
  path = sources_path + version

  unless path.directory?
    Base.remove_if_present(path)
    sources_path
    Base.with_env 'VERSION', version do
      Base.system('rails', path, '--freeze')
    end
  end
  self.class.used_sources << path

  paths = FileList.new
  Base.chdir(path) do
    File.open('vendor/rails/railties/lib/tasks/documentation.rake') do |f|
      true until f.readline['Rake::RDocTask.new("rails")']
      until (line = f.readline.strip) == '}'
        if line['rdoc.rdoc_files.include']
          paths.include(line[/'(.*)'/, 1])
        elsif line['rdoc.rdoc_files.exclude']
          paths.exclude(line[/'(.*)'/, 1])
        end
      end
    end
    paths.resolve
  end
  Base.add_task(
    :src_path => path,
    :doc_path => "rails-#{version}",
    :paths => paths.to_a,
    :title => "rails-#{version}"
  )
end