Class: Nanoc3::CLI::Commands::Update

### Home Classes Methods

### In Files

- lib/nanoc3/cli/commands/update.rb

### Parent

Cri::Command

### Methods

- #aliases
- #long_desc
- #name
- #option_definitions
- #run
- #short_desc
- #usage

### Files

- ChangeLog
- LICENSE

### Class/Module Index

Quicksearch

- Nanoc3
- Nanoc3::ArrayExtensions
- Nanoc3::CLI
- Nanoc3::CLI::Base
- Nanoc3::CLI::Commands
- Nanoc3::CLI::Commands::Autocompile
- Nanoc3::CLI::Commands::Compile
- Nanoc3::CLI::Commands::CreateItem
- Nanoc3::CLI::Commands::CreateLayout
- Nanoc3::CLI::Commands::CreateSite
- Nanoc3::CLI::Commands::Debug
- Nanoc3::CLI::Commands::Help
- Nanoc3::CLI::Commands::Info
- Nanoc3::CLI::Commands::Update
- Nanoc3::CLI::Commands::View
- Nanoc3::CLI::Logger
- Nanoc3::CodeSnippet
- Nanoc3::Compiler
- Nanoc3::CompilerDSL
- Nanoc3::Context
- Nanoc3::DataSource
- Nanoc3::DataSources
- Nanoc3::DataSources::Delicious
- Nanoc3::DataSources::Filesystem
- Nanoc3::DataSources::FilesystemUnified
- Nanoc3::DataSources::FilesystemVerbose
- Nanoc3::DataSources::LastFM
- Nanoc3::DataSources::Twitter
- Nanoc3::DependencyTracker
- Nanoc3::DirectedGraph
- Nanoc3::Errors
- Nanoc3::Errors::CannotDetermineFilter
- Nanoc3::Errors::CannotLayoutBinaryItem
- Nanoc3::Errors::CannotUseBinaryFilter
- Nanoc3::Errors::CannotUseTextualFilter
- Nanoc3::Errors::DataNotYetAvailable
- Nanoc3::Errors::Generic
- Nanoc3::Errors::NoMatchingCompilationRuleFound
- Nanoc3::Errors::NoMatchingRoutingRuleFound
- Nanoc3::Errors::NoRulesFileFound
- Nanoc3::Errors::RecursiveCompilation
- Nanoc3::Errors::UnknownDataSource
- Nanoc3::Errors::UnknownFilter
- Nanoc3::Errors::UnknownLayout
- Nanoc3::Errors::UnmetDependency
- Nanoc3::Extra
- Nanoc3::Extra::AutoCompiler
- Nanoc3::Extra::CHiCk
- Nanoc3::Extra::CHiCk::CacheController
- Nanoc3::Extra::CHiCk::Client
- Nanoc3::Extra::CHiCk::RackClient
- Nanoc3::Extra::Deployers
- Nanoc3::Extra::Deployers::Rsync
- Nanoc3::Extra::FileProxy
- Nanoc3::Extra::TimeExtensions
- Nanoc3::Extra::VCS
- Nanoc3::Extra::VCSes
- Nanoc3::Extra::VCSes::Bazaar
- Nanoc3::Extra::VCSes::Dummy
- Nanoc3::Extra::VCSes::Git
- Nanoc3::Extra::VCSes::Mercurial
- Nanoc3::Extra::VCSes::Subversion
- Nanoc3::Extra::Validators
- Nanoc3::Extra::Validators::Links
- Nanoc3::Extra::Validators::Links::EachPairEnumerator
- Nanoc3::Extra::Validators::W3C
- Nanoc3::Filter
- Nanoc3::Filters
- Nanoc3::Filters::BlueCloth
- Nanoc3::Filters::CodeRay
- Nanoc3::Filters::ColorizeSyntax
- Nanoc3::Filters::ERB
- Nanoc3::Filters::Erubis
- Nanoc3::Filters::Haml
- Nanoc3::Filters::Kramdown
- Nanoc3::Filters::Less
- Nanoc3::Filters::Markaby
- Nanoc3::Filters::Maruku
- Nanoc3::Filters::RDiscount
- Nanoc3::Filters::RDoc
- Nanoc3::Filters::Rainpress
- Nanoc3::Filters::RedCloth
- Nanoc3::Filters::RelativizePaths
- Nanoc3::Filters::RubyPants
- Nanoc3::Filters::Sass
- Nanoc3::HashExtensions
- Nanoc3::Helpers
- Nanoc3::Helpers::Blogging
- Nanoc3::Helpers::Breadcrumbs
- Nanoc3::Helpers::Capturing
- Nanoc3::Helpers::Filtering
- Nanoc3::Helpers::HTMLEscape
- Nanoc3::Helpers::LinkTo
- Nanoc3::Helpers::Rendering
- Nanoc3::Helpers::Tagging
- Nanoc3::Helpers::Text
- Nanoc3::Helpers::XMLSitemap
- Nanoc3::Item
- Nanoc3::ItemRep
- Nanoc3::Layout
- Nanoc3::NotificationCenter
- Nanoc3::PluginRegistry
- Nanoc3::PluginRegistry::PluginMethods
- Nanoc3::Rule
- Nanoc3::RuleContext
- Nanoc3::Site
- Nanoc3::StringExtensions
- Nanoc3::Tasks
- Nanoc3::Tasks::Clean
- Array
- Enumerable
- Hash
- Object
- OrderedHash
- String
- Time

No matching classes.

# Nanoc3::CLI::Commands::Update

### Public Instance Methods

aliases() click to toggle source

    # File lib/nanoc3/cli/commands/update.rb, line 10
    def aliases
      []
    end

long_desc() click to toggle source

    # File lib/nanoc3/cli/commands/update.rb, line 18
    def long_desc
      'Update the data stored by the data source to a newer format. The ' +
      'format in which data is stored can change between releases, and ' +
      'even though backward compatibility is usually preserved, it is ' +
      'often a good idea to store the site data in a newer format so newer ' +
      'features can be taken advantage of.' +
      "\n" +
      'This command will change data, and it is therefore recommended to ' +
      'make a backup in case something goes wrong.'
    end

name() click to toggle source

    # File lib/nanoc3/cli/commands/update.rb, line 6
    def name
      'update'
    end

option_definitions() click to toggle source

    # File lib/nanoc3/cli/commands/update.rb, line 33
    def option_definitions
      [
        # --vcs
        {
          :long => 'vcs', :short => 'c', :argument => :required,
          :desc => 'select the VCS to use'
        },
        # --yes
        {
          :long => 'yes', :short => 'y', :argument => :forbidden,
          :desc => 'updates the data without warning'
        }
      ]
    end

run(options, arguments) click to toggle source

    # File lib/nanoc3/cli/commands/update.rb, line 48
    def run(options, arguments)
      # Check arguments
      if arguments.size != 0
        $stderr.puts "usage: #{usage}"
        exit 1
      end

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

      # 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 update the ' +
                     'content for this site? Updating the site content ' +
                     'will change the structure of 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 'If this nanoc site is versioned using a VCS ' +
                     'supported by nanoc, consider using the --vcs option ' +
                     'to have nanoc perform add/delete/move operations ' +
                     'using the specified VCS. To get a list of VCSes ' +
                     'supported by nanoc, issue the "info" command.'
        $stderr.puts
        $stderr.puts 'To continue, use the -y/--yes option, like "nanoc3 ' +
                     'update -y".'
        exit 1
      end

      # Update
      @base.site.data_sources.each do |data_source|
        data_source.update
      end
    end

short_desc() click to toggle source

    # File lib/nanoc3/cli/commands/update.rb, line 14
    def short_desc
      'update the data stored by the data source to a newer version'
    end

usage() click to toggle source

    # File lib/nanoc3/cli/commands/update.rb, line 29
    def usage
      "nanoc3 update [options]"
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.