Commit 65be043d authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Rename --old-version option to --import. 

Consequently OldVersions module now becomes Importer.
parent b1544b69

Rakefile

+4 −4
Original line number Diff line number Diff line
@@ -233,10 +233,10 @@ task :sdk => :sass do 
    "--output", OUT_DIR,

    "--config", "#{SDK_DIR}/extjs/docs/config.json",

    "--examples-base-url", "extjs-build/examples/",

    "--old-version", "2.3.0:compare/ext23",

    "--old-version", "3.4.0:compare/ext34",

    "--old-version", "4.0.7:compare/ext407",

    "--old-version", "4.1.1",

    "--import", "Ext JS 2:compare/ext23",

    "--import", "Ext JS 3:compare/ext34",

    "--import", "Ext JS 4.0.7:compare/ext407",

    "--import", "Ext JS 4.1.1",

    "--seo",

    "--tests"

  )

lib/jsduck/app.rb

+2 −2
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ require 'jsduck/logger' 
require 'jsduck/assets'

require 'jsduck/json_duck'

require 'jsduck/io'

require 'jsduck/old_versions'

require 'jsduck/importer'

require 'jsduck/lint'

require 'jsduck/template_dir'

require 'jsduck/class_writer'
@@ -47,7 +47,7 @@ module JsDuck 
      result = aggregate(parsed_files)

      @relations = filter_classes(result)

      InheritDoc.new(@relations).resolve_all

      OldVersions.import(@opts.old_versions, @relations)

      Importer.import(@opts.imports, @relations)

      Lint.new(@relations).run



      # Initialize guides, videos, examples, ...

lib/jsduck/old_versions.rb→lib/jsduck/importer.rb

+6 −6
Original line number Diff line number Diff line
@@ -4,21 +4,21 @@ require 'jsduck/null_object' 
module JsDuck



  # Reads in JSDuck exports of different versions of docs.

  module OldVersions

  module Importer

    module_function



    # Loads in exported docs and generates @since tags based on that data.

    def import(versions, relations)

      if versions.length > 0

        generate_since_tags(read_all(versions), relations)

    def import(imports, relations)

      if imports.length > 0

        generate_since_tags(read_all(imports), relations)

      end

    end



    # Reads in data for all versions, returning array of

    # version/class-data pairs.  We don't use a hash to preserve the

    # order of versions (from oldest to newest).

    def read_all(versions)

      versions.map do |ver|

    def read_all(imports)

      imports.map do |ver|

        {

          :version => ver[:version],

          :classes => ver[:path] ? read(ver[:path]) : current_version,

lib/jsduck/options.rb

+8 −7
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ module JsDuck 
    attr_accessor :local_storage_db

    attr_accessor :touch_examples_ui

    attr_accessor :ext_namespaces

    attr_accessor :old_versions

    attr_accessor :imports



    def initialize

      @input_files = []
@@ -113,7 +113,7 @@ module JsDuck 
      @local_storage_db = "docs"

      @touch_examples_ui = false

      @ext_namespaces = ["Ext"]

      @old_versions = []

      @imports = []



      # enable all warnings except :link_auto

      Logger.instance.set_warning(:all, true)
@@ -362,13 +362,14 @@ module JsDuck 
          @ext_namespaces = ns

        end



        opts.on('--old-version=VERSION:PATH',

          "Path to exported docs of specified version.",

          "For the current version, leave the path portion off.", " ") do |v|

        opts.on('--import=VERSION:PATH',

          "Imports docs of a particular version generating @since tags.",

          "Several versions can be imported using the option multiple times.",

          "To specify the current version, leave the :PATH portion off.", " ") do |v|

          if v =~ /\A(.*?):(.*)\Z/

            @old_versions << {:version => $1, :path => canonical($2)}

            @imports << {:version => $1, :path => canonical($2)}

          else

            @old_versions << {:version => v}

            @imports << {:version => v}

          end

        end

spec/old_versions_spec.rb→spec/importer_spec.rb

+4 −4
Original line number Diff line number Diff line 
require "jsduck/old_versions"

require "jsduck/importer"



describe "JsDuck::OldVersions#generate_since_tags" do

describe "JsDuck::Importer#generate_since_tags" do



  before do

    @versions = [
@@ -17,7 +17,7 @@ describe "JsDuck::OldVersions#generate_since_tags" do 
        },

      },

      {

        :version => "3.0", :classes => JsDuck::OldVersions.current_version

        :version => "3.0", :classes => JsDuck::Importer.current_version

      }

    ]
@@ -32,7 +32,7 @@ describe "JsDuck::OldVersions#generate_since_tags" do 
      {:name => "ClassWithNewName", :meta => {}, :alternateClassNames => ["ClassWithOldName"]},

    ].map {|cfg| JsDuck::Class.new(cfg) }



    JsDuck::OldVersions.generate_since_tags(@versions, @relations)

    JsDuck::Importer.generate_since_tags(@versions, @relations)

  end



  it "adds @since 1.0 to VeryOldClass" do