Class: Nanoc2::CLI::SwitchCommand

Inherits:
Cri::Command
  • Object
show all
Defined in:
lib/nanoc2/cli/commands/switch.rb

Overview

:nodoc:

Instance Method Summary collapse

Instance Method Details

#aliases ⇒ Object 



9
10
11
 
# File 'lib/nanoc2/cli/commands/switch.rb', line 9

def aliases
  []
end

#long_desc ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/nanoc2/cli/commands/switch.rb', line 17

def long_desc
  'Move the data stored in the site to a new, given data source.' +
  "\n" +
  'The given new data source may need additional configuration ' +
  'parameters that cannot be specified on the commandline. These ' +
  'should be stored in the configuration file (config.yaml) BEFORE ' +
  'executing the switch command.' +
  "\n" +
  'This command first loads all existing data into memory, destroys ' +
  'the on-disk data, changes the site\'s data source, and finally ' +
  'writes the data back to the disk using the new data source. Because ' +
  'of this action\'s destructive nature, THIS OPERATION SHOULD NOT BE ' +
  'INTERRUPTED as interruption could result in data loss.' +
  "\n" +
  'This command will change data, and it is therefore recommended to ' +
  'make a backup in case something goes wrong.'
end

#name ⇒ Object 



5
6
7
 
# File 'lib/nanoc2/cli/commands/switch.rb', line 5

def name
  'switch'
end

#option_definitions ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/nanoc2/cli/commands/switch.rb', line 39

def option_definitions
  [
    # --vcs
    {
      :long => 'vcs', :short => 'c', :argument => :required,
      :desc => 'select the VCS to use'
    },
    # --yes
    {
      :long => 'yes', :short => 'y', :argument => :forbidden,
      :desc => 'switches the data source without warning'
    },
    # --datasource
    {
      :long => 'datasource', :short => 'd', :argument => :required,
      :desc => 'specify the new data source for the site'
    }
  ]
end

#run(options, arguments) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/nanoc2/cli/commands/switch.rb', line 59

def run(options, arguments)
  # Check arguments
  if arguments.size != 0
    $stderr.puts "usage: #{usage}"
    exit 1
  end

  # Check options
  unless options.has_key?(:datasource)
    $stderr.puts 'A new data source should be specified using the ' +
                 '-d/--datasource option.'
    exit 1
  end

  # Find data source
  data_source = Nanoc2::DataSource.named(options[:datasource])
  if data_source.nil?
    $stderr.puts "Unrecognised data source: #{options[:datasource]}"
    exit 1
  end

  # Make sure we are in a nanoc site directory
  @base.require_site

  # Set VCS if possible
  @base.set_vcs(options[:vcs])

  # Check for -y switch
  unless options.has_key?(:yes)
    $stderr.puts '*************'
    $stderr.puts '** WARNING **'
    $stderr.puts '*************'
    $stderr.puts
    $stderr.puts 'Are you absolutely sure you want to set up the data ' +
                 'source for this site? Setting up the data source ' +
                 'will remove existing data. This operation is ' +
                 'destructive and cannot be reverted. Please do not ' +
                 'interrupt this operation; doing so can result in ' +
                 'data loss. As always, consider making a backup copy.'
    $stderr.puts
    $stderr.puts 'To continue, use the -y/--yes option, like "nanoc2 ' +
                 'switch -y".'
    exit 1
  end

  # Setup notifications
  Nanoc2::NotificationCenter.on(:file_created) do |file_path|
    Nanoc2::CLI::Logger.instance.file(:high, :create, file_path)
  end
  Nanoc2::NotificationCenter.on(:file_updated) do |file_path|
    Nanoc2::CLI::Logger.instance.file(:high, :update, file_path)
  end

  # Load data
  @base.site.load_data

  # Destroy existing data
  @base.site.data_source.destroy

  # Update configuration
  @base.site.config[:data_source] = options[:datasource]
  @base.site.instance_eval { @data_source = data_source.new(self) }
  File.open('config.yaml', 'w') { |io| io.write(YAML.dump(@base.site.config.stringify_keys)) }

  # Set VCS on new data source if possible
  @base.set_vcs(options[:vcs])

  @base.site.data_source.loading do
    # Create initial data source
    @base.site.data_source.setup

    # Store all data
    @base.site.pages.each { |p| @base.site.data_source.save_page(p) }
    @base.site.data_source.save_page_defaults(@base.site.page_defaults)
    @base.site.layouts.each { |l| @base.site.data_source.save_layout(l) }
    @base.site.templates.each { |t| @base.site.data_source.save_template(t) }
    @base.site.data_source.save_code(@base.site.code)
  end
end

#short_desc ⇒ Object 



13
14
15
 
# File 'lib/nanoc2/cli/commands/switch.rb', line 13

def short_desc
  'switch the site to a new data source'
end

#usage ⇒ Object 



35
36
37
 
# File 'lib/nanoc2/cli/commands/switch.rb', line 35

def usage
  "nanoc2 switch [options]"
end