Class: Command::Setting

Inherits:
CommandBase show all
Defined in:
lib/command/setting.rb

Defined Under Namespace

Classes: InvalidVariableName, InvalidVariableType, UnknownVariableType

Constant Summary collapse

TYPE_OF_VALUE = 
{
  TrueClass => :boolean, FalseClass => :boolean, Fixnum => :integer,
  Float => :float, String => :string
}
INVISIBLE = 
true
SETTING_VARIABLES = 
{
  local: {
    # 変数名 => [受け付ける型, 説明(, 不可視化フラグ)]
    "convert.no-epub" => [:boolean, "EPUB変換を無効にするか"],
    "convert.no-mobi" => [:boolean, "MOBI変換を無効にするか"],
    "convert.no-strip" => [:boolean, "MOBIのstripを無効にするか\n" +
                                     " " * 6 + "※注意：KDP用のMOBIはstripしないでください"],
    "convert.no-zip" => [:boolean, "i文庫用のzipファイルを作らない"],
    "convert.no-open" => [:boolean, "変換終了時に保存フォルダを開かない"],
    "convert.copy_to" => [:directory, "変換したらこのフォルダにコピーする\n" +
                                      " " * 6 + "※注意：存在しないフォルダだとエラーになる"],
    "convert.inspect" => [:boolean, "常に変換時に調査結果を表示するか"],
    "download.interval" => [:float, "各話DL時に指定した秒数待機する。デフォルト0"],
    "download.wait-steps" => [:integer, "この値で指定した話数ごとにウェイトを入れる\n" +
                                   " " * 6 + "※注意：11以上を設定してもなろうの場合は10話ごとにウェイトが入ります"],
    "send.without-freeze" => [:boolean, "`全話'送信時に凍結された小説は対象外に"],
    "update.strong" => [:boolean, "更新漏れが無いように改稿日の分は必ずDLする"],
    "device" => [:string, "変換、送信対象の端末(sendの--help参照)"],
    "multiple-delimiter" => [:string, "--multiple指定時の区切り文字"],
  },
  global: {
    "aozoraepub3dir" => [:directory, "AozoraEpub3のあるフォルダを指定", INVISIBLE],
    "difftool" => [:string, "Diffで使うツールのパスを指定する"],
    "difftool.arg" => [:string, "difftoolで使う引数を設定(オプション)"],
    "no-color" => [:boolean, "カラー表示を無効にする"],
    "over18" => [:boolean, "", INVISIBLE],
  }
}

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CommandBase

execute!, #force_change_settings_function, help, #hook_call, #load_local_settings, #tagname_to_ids

Constructor Details

#initialize ⇒ Setting

Returns a new instance of Setting.



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
58
59
60
61
62
63
64
65
 
# File 'lib/command/setting.rb', line 29

def initialize
  super("[<name>=<value> ...] [options]")
  @opt.separator <<-EOS

  ・各コマンドの設定の変更が出来ます。
  ・Global な設定はユーザープロファイルに保存され、すべての narou コマンドで使われます。
  ・下の一覧は一部です。すべてを確認するには -a オプションを付けて確認して下さい。

  Local Variable List:
    <name>           <value>              説明
  EOS
  @opt.separator(get_variable_list_strings(:local))

  @opt.separator("\n  Global Variable List:")
  @opt.separator(get_variable_list_strings(:global))

  @opt.separator <<-EOS

  Examples:
narou setting --list
narou setting convert.no-open=true
narou setting convert.no-epub=   # 右辺に何も書かないとその設定を削除できる
narou setting convert.copy_to=C:/dropbox/mobi
narou s convert.copy_to="C:\\Documents and Settings\\user\\epub"

  Options:
  EOS
  @opt.on("-l", "--list", "現在の設定値を確認する") {
    output_setting_list
    exit 0
  }
  @opt.on("-a", "--all", "設定できる全ての変数名を表示する") {
    @options["all"] = true
    display_variable_list
    exit 0
  }
end

Class Method Details

.oneline_help ⇒ Object 



11
12
13
 
# File 'lib/command/setting.rb', line 11

def self.oneline_help
  "各コマンドの設定を変更します"
end

.variable_type_to_description(type) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/command/setting.rb', line 67

def self.variable_type_to_description(type)
  case type
  when :boolean
    "true/false  "
  when :integer
    "整数        "
  when :float
    "小数点数    "
  when :string
    "文字列      "
  when :directory
    "フォルダパス"
  when :file
    "ファイルパス"
  else
    raise UnknownVariableType, type
  end
end

Instance Method Details

#casting_variable(name, value) ⇒ Object

値の文字列を設定に基づいた型にキャストして、[scope, value] 形式で返す 不正な設定名もしくは値の場合は例外を吐く



99
100
101
102
103
104
105
106
 
# File 'lib/command/setting.rb', line 99

def casting_variable(name, value)
  scope = get_scope_of_variable_name(name)
  unless scope
    raise InvalidVariableName, "#{name} は不明な名前です"
  end
  casted_value = string_cast_to_type(value, SETTING_VARIABLES[scope][name][0])
  [scope, casted_value]
end

#display_variable_list ⇒ Object 



250
251
252
253
254
255
256
 
# File 'lib/command/setting.rb', line 250

def display_variable_list
  puts "Local Variable List:"
  puts get_variable_list_strings(:local).gsub(/^ {4}/, "")
  puts
  puts "Global Variable List:"
  puts get_variable_list_strings(:global).gsub(/^ {4}/, "")
end

#execute(argv) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/command/setting.rb', line 162

def execute(argv)
  super
  if argv.empty?
    puts @opt.help
    return
  end
  settings = {
    local: Inventory.load("local_setting", :local),
    global: Inventory.load("global_setting", :global)
  }
  device = Narou.get_device
  self.extend(device.get_hook_module) if device
  argv.each do |arg|
    name, value = arg.split("=", 2).map(&:strip)
    if name == ""
      error "書式が間違っています。変数名=値 のように書いて下さい"
      next
    end
    scope = get_scope_of_variable_name(name)
    unless scope
      error "#{name} という変数は存在しません"
      next
    end
    if value.nil?
      error "書式が間違っています。#{name}=値 のように書いて下さい"
      next
    end
    if value == ""
      hook_call(:modify_settings, settings[scope], name, nil)
      next
    end
    begin
      scope, casted_value = casting_variable(name, value)
    rescue InvalidVariableName, InvalidVariableType => e
      error e.message
      next
    end
    hook_call(:modify_settings, settings[scope], name, casted_value)
  end
  settings[:local].save
  settings[:global].save
end

#get_scope_of_variable_name(name) ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/command/setting.rb', line 86

def get_scope_of_variable_name(name)
  [:local, :global].each do |scope|
    if SETTING_VARIABLES[scope].include?(name)
      return scope
    end
  end
  nil
end

#get_variable_list_strings(scope) ⇒ Object 



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/command/setting.rb', line 239

def get_variable_list_strings(scope)
  result = ""
  SETTING_VARIABLES[scope].each do |name, info|
    if @options["all"] || info[2] != INVISIBLE
      type_description = self.class.variable_type_to_description(info[0])
      result << "    <bold><green>#{name.ljust(18)}</green></bold> #{type_description} #{info[1]}\n".termcolor
    end
  end
  result
end

#modify_settings(scoped_settings, name, value) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/command/setting.rb', line 205

def modify_settings(scoped_settings, name, value)
  if value.nil?
    scoped_settings.delete(name)
    puts "#{name} の設定を削除しました"
  else
    scoped_settings[name] = value
    puts "#{name} を #{value} に設定しました"
  end
  if name == "device" && value
    modify_settings_when_device_changed(scoped_settings)
  end
end

#modify_settings_when_device_changed(settings) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/command/setting.rb', line 218

def modify_settings_when_device_changed(settings)
  device = Device.create(settings["device"])
  message = StringIO.new
  device.get_relative_variables.each do |name, value|
    if value.nil?
      settings.delete(name)
      message.puts "  <bold><red>← #{name} が削除されました</red></bold>".termcolor
    elsif settings[name].nil? || settings[name] != value
      settings[name] = value
      message.puts "  <bold><green>→ #{name} が #{value} に変更されました</green></bold>".termcolor
    end
  end
  if message.length > 0
    puts "端末を#{device.display_name}に指定したことで、以下の関連設定が変更されました"
    puts message.string
  end
rescue Device::UnknownDevice => e
  error e.message
  puts "設定できるのは #{Device::DEVICES.keys.join(", ")} です"
end

#output_setting_list ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/command/setting.rb', line 146

def output_setting_list
  settings = {
    local: Inventory.load("local_setting", :local),
    global: Inventory.load("global_setting", :global)
  }
  settings.each do |scope, scoped_settings|
    puts "[#{scope.capitalize} Variables]"
    scoped_settings.each do |name, value|
      if value =~ / /
        value = "'#{value}'"
      end
      puts "<bold><green>#{name}</green></bold>=#{value}".termcolor
    end
  end
end

#string_cast_to_type(value, type) ⇒ Object 



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
138
139
140
141
142
143
144
 
# File 'lib/command/setting.rb', line 108

def string_cast_to_type(value, type)
  result = nil
  case type
  when :boolean
    case value
    when /true/i
      result = true
    when /false/i
      result = false
    else
      raise InvalidVariableType, type
    end
  when :integer
    if value =~ /^[+-]?\d+$/
      result = value.to_i
    else
      raise InvalidVariableType, type
    end
  when :float
    if value =~ /^[+-]?\d+\.?\d*$/
      result = value.to_f
    else
      raise InvalidVariableType, type
    end
  when :directory, :file
    if File.method("#{type}?").call(value)
      result = File.expand_path(value)
    else
      raise InvalidVariableType, type
    end
  when :string
    result = value
  else
    raise UnknownVariableType, type
  end
  result
end