Class: Doc::BaseTask

Inherits:
Object
  • Object
show all
Defined in:
lib/doc/base_task.rb

Direct Known Subclasses

Builder, Merger

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(documentor, options) ⇒ BaseTask

Returns a new instance of BaseTask.



8
9
10
11
12
13
 
# File 'lib/doc/base_task.rb', line 8

def initialize(documentor, options)
  @documentor = documentor
  @title = options[:title].to_s
  @dir_name = options[:dir_name].to_s
  doc_dir.touch if doc_dir.exist?
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



7
8
9
 
# File 'lib/doc/base_task.rb', line 7

def config
  @config
end

#dir_name ⇒ Object (readonly)

Returns the value of attribute dir_name.



7
8
9
 
# File 'lib/doc/base_task.rb', line 7

def dir_name
  @dir_name
end

#documentor ⇒ Object (readonly)

Returns the value of attribute documentor.



7
8
9
 
# File 'lib/doc/base_task.rb', line 7

def documentor
  @documentor
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



7
8
9
 
# File 'lib/doc/base_task.rb', line 7

def title
  @title
end

Class Method Details

.state_methods(name, data_code_for_state) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/doc/base_task.rb', line 19

def self.state_methods(name, data_code_for_state)
  class_eval <<-RUBY, __FILE__, __LINE__
    def #{name}_state
      @#{name}_state ||= #{data_code_for_state}
    end
    def #{name}_state_path
      doc_dir / '.#{name}_state'
    end
    def #{name}_state_changed?
      !#{name}_state_path.exist? || Marshal.load(#{name}_state_path.read) != #{name}_state
    rescue true
    end
    def write_#{name}_state
      #{name}_state_path.write(Marshal.dump(#{name}_state))
    end
  RUBY
end

Instance Method Details

#control_files_exist? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
51
52
 
# File 'lib/doc/base_task.rb', line 48

def control_files_exist?
  %w[created.rid index.html].all? do |name|
    (doc_dir / name).exist?
  end
end

#doc_dir ⇒ Object 



15
16
17
 
# File 'lib/doc/base_task.rb', line 15

def doc_dir
  documentor.docs_dir / dir_name
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/doc/base_task.rb', line 44

def eql?(other)
  config.eql?(other.config)
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/doc/base_task.rb', line 81

def failed?
  @state == :failed
end

#hash ⇒ Object 



41
42
43
 
# File 'lib/doc/base_task.rb', line 41

def hash
  config.hash
end

#in_progress_message(message) ⇒ Object 



89
90
91
92
93
94
95
 
# File 'lib/doc/base_task.rb', line 89

def in_progress_message(message)
  if Progress.running?
    Progress.note = message
  else
    $stderr.puts message
  end
end

#loaded_gem_version(gem) ⇒ Object 



85
86
87
 
# File 'lib/doc/base_task.rb', line 85

def loaded_gem_version(gem)
  Gem.loaded_specs[gem].version
end

#run(force = false) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/doc/base_task.rb', line 59

def run(force = false)
  if force || run?
    if doc_dir.exist?
      in_progress_message %W[rm -r #{doc_dir}].shelljoin
      doc_dir.rmtree
    end
    build
    write_config_state
    @state = control_files_exist? ? :succeeded : :failed
  end
rescue SystemExit
  @state = :failed
end

#run? ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/doc/base_task.rb', line 54

def run?
  config_state_changed? || !control_files_exist?
end

#succeeded? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/doc/base_task.rb', line 77

def succeeded?
  @state == :succeeded
end

#symlink_to(path) ⇒ Object 



73
74
75
 
# File 'lib/doc/base_task.rb', line 73

def symlink_to(path)
  (path / doc_dir.basename).make_symlink(doc_dir.relative_path_from(path))
end