sleipnir-api 0.2.1 → 0.3.0

data/lib/sleipnir_api/profile.rb

@@ -1,46 +1,150 @@
 require "sleipnir_api/util"
+require "sleipnir_api/profile/ini"
+require "sleipnir_api/profile/section"
+require "sleipnir_api/profile/key"
 
 module SleipnirAPI
 
   #
   # このクラスは Sleipnir の COM オブジェクト (Sleipnir.API) の wrapper クラスです。
-  # Sleipnir の ini ファイルを操作する API を定義しています。
+  # Sleipnir の ini ファイルを操作する低レベルな API を定義しています。
+  #
+  # ini ファイル・セクション・キーに対応するオブジェクトを用意してあるので
+  # 通常はそちらを利用してください。
+  #
+  # * SleipnirAPI::Profile::Ini
+  # * SleipnirAPI::Profile::Section
+  # * SleipnirAPI::Profile::Key
   #
   # このオブジェクトは SleipnirAPI::Sleipnir#profile で取得します。
   #
-  # 例:
+  # === 高レベル API の例
+  #
+  #   pnir = SleipnirAPI.new
+  #   prof = pnir.profile
+  #
+  #   # デフォルト値
+  #   bar = prof.script.foo_section.bar_key
+  #   # 以下と同じ
+  #   # bar = prof.ini("Script.ini").section("foo_section").key("bar_key")
+  #
+  #   bar.write_string("foobar")
+  #   bar.get_string                              #=> "foobar"
+  #   bar.delete
+  #   bar.get_string(:default => "default value") #=> "default value"
+  #
+  #   # 暗号化
+  #   bar_cipher = prof.script.foo_section.bar_key(:cipher => true)
+  #   bar_cipher.write_string("foobar")
+  #   bar_cipher.get_string                       #=> "foobar"
+  #   bar.get_string                              #=> "tibv&DmD[vq)"
+  #   bar_cipher.get_string(:cipher => false)     #=> "tibv&DmD[vq)"
+  #
+  #   # 連番データの取得
+  #   history = prof.History.History2.key("URL-data0").list("URLCount")
+  #
+  # === 低レベル API の例
   #
   #   pnir = SleipnirAPI.new
-  #   ini = pnir.profile
+  #   prof = pnir.profile
   #
   #   # デフォルト値
-  #   ini.write_string("section", "key", "foobar")
-  #   ini.get_string("section", "key")                              #=> "foobar"
-  #   ini.delete("section", "key")
-  #   ini.get_string("section", "key", :default => "default value") #=> "default value"
+  #   prof.write_string("section_foo", key_bar, "foobar")
+  #   prof.get_string("section_foo", key_bar)                              #=> "foobar"
+  #   prof.delete("section_foo", key_bar)
+  #   prof.get_string("section_foo", key_bar, :default => "default value") #=> "default value"
   #
   #   # 暗号化
-  #   ini.write_string("section", "key", "foobar", :cipher => true)
-  #   ini.get_string("section", "key")                              #=> "tF4DxDH)[uUu"
-  #   ini.get_string("section", "key", :cipher => true)             #=> "foobar"
+  #   prof.write_string("section_foo", key_bar, "foobar", :cipher => true)
+  #   prof.get_string("section_foo", key_bar, :cipher => true)             #=> "foobar"
+  #   prof.get_string("section_foo", key_bar)                              #=> "tF4DxDH)[uUu"
   #
-  #   # ファイル名指定
-  #   count = ini.get_int("Proxy", "Count", :ini => "proxy.ini")
-  #   (0...count).each do |i|
-  #     p ini.get_string("Proxy", "Proxy#{i}_Title", :ini => "proxy.ini")
-  #   end
+  #   # 連番データの取得
+  #   history = prof.list("History2", "URL-data0", "URLCount", :ini => "History.ini")
   #
   class Profile
     include SleipnirAPI::Util
+    include OptionArgument
+    include DataUtil
 
     # SleipnirAPI::Sleipnir object
-    attr_reader :sleipnir
+    attr_reader :sleipnir, :default_opts
 
-    def initialize(sleipnir)
+    def initialize(sleipnir, default_opts = nil)
       @sleipnir = sleipnir
+      @user_path = sleipnir.user_path
+      @default_opts = default_opts
     end
 
+
+    # call-seq:
+    #   list(section, keyfmt, countkey="Count")
+    #   list(section, keyfmt, countkey="Count", :default => "default value")
+    #   list(section, keyfmt, countkey="Count", :cipher => true)
+    #   list(section, keyfmt, countkey="Count", :cipher => true, :default => "default value")
+    #   list(section, keyfmt, countkey="Count", :ini => ini_filename)
+    #   list(section, keyfmt, countkey="Count", :ini => ini_filename, :default => "default value")
+    #
+    # 以下のような連番キーのデータをすべて読み込み配列で返します。
+    #
+    #   [History2]
+    #   SearchCount=2
+    #   Search-data0="Ruby"
+    #   Search-data1="Sleipnir"
+    #
+    # * +keyfmt+ には連番キーを生成するためのテンプレート文字列を指定します。
+    #   テンプレート文字列からフォーマット文字列への変換ルールは #list_key_format を参照してください。
+    # * +countkey+ には連番キーの個数を記録しているキー名を指定します。
+    #   デフォルトは "Count" です。
+    # * +opts+ の説明は #get_string を参照してください。
+    # * +block+ を指定するとフォーマットされた連番キー(文字列)を引数に block を評価して
+    #   その結果を返します。
+    #
+    # 例:
+    #
+    #   pnir = SleipnirAPI.connect
+    #   prof = pnir.profile
+    #   prof.list("History2", "Search-data0", "SearchCount", :ini => "History.ini") #=> ["Ruby", "Sleipnir"]
+    #
+    # See Also: #list_key_format
+    def list(section, keyfmt, countkey="Count", opts = nil, &block)
+      keyfmt = list_key_format(keyfmt)
+      block ||= lambda {|key| get_string(section, key, opts) }
+      (0...get_int(section, countkey, opts)).map{|i| keyfmt % i }.map(&block)
+    end
+
+    # 連番キーを生成するためのフォーマット文字列を返します。
+    #
+    # フォーマット文字列は以下のルールで生成します。
     #
+    # * 引数に「%(数字)d」が含まれていればそのまま返す。
+    # * 引数に連続する 0 があれば、そこを連番箇所と判断して %d に変換して返す。
+    #   * 0 が複数箇所に存在する場合は最後の 0 が利用される
+    #   * 連続する 0 の場合、幅指定のフォーマットになる
+    # * 0 が存在しない場合は、以下の場所を連番箇所と判断して %d に変換して返す。
+    #   * 最初のアンダースコアの前
+    #   * 文字列末尾
+    #
+    # 例:
+    #
+    #  list_key_format("Search-data%d")     #=> Search-data%d
+    #
+    #  list_key_format("Foo_Bar0_Name")     #=> Foo_Bar%d_Name
+    #  list_key_format("Foo0_Bar0_Name")    #=> Foo0_Bar%d_Name
+    #  list_key_format("Foo0_Bar000_Name")  #=> Foo0_Bar%03d_Name
+    #
+    #  list_key_format("Foo_Bar_Name")      #=> Foo%d_Bar_Name
+    #  list_key_format("Name")              #=> Name%d
+    #
+    def list_key_format(keyfmt)
+      return keyfmt if keyfmt =~ /%\d*d/
+      return keyfmt if keyfmt.sub!(/(0+)(\D*)\z/) {
+        n = $1.length
+        (n == 1) ? "%d#{$2}" : "%0#{n}d#{$2}"
+      }
+      return keyfmt.sub(/(_|\z)/) { "%d#{$1}" }
+    end
+
     # call-seq:
     #   get_string(section, key)
     #   get_string(section, key, :default => "default value")
@@ -61,7 +165,8 @@ module SleipnirAPI
     #   同時に指定した場合 <tt>:cipher</tt> は無視されます。
     #
     def get_string(section, key, opts = nil)
-      opts ||= {}
+      section, key = str(section, key)
+      opts = options(opts, :cipher, :ini, :default)
       if opts[:ini]
         api.GetProfileStringEx(section, key, opts[:default], expand_user_path(opts[:ini]))
       elsif opts[:cipher]
@@ -71,7 +176,6 @@ module SleipnirAPI
       end
     end
 
-    #
     # call-seq:
     #   get_int(section, key)
     #   get_int(section, key, :default => -1)
@@ -84,7 +188,8 @@ module SleipnirAPI
     # 詳細は get_string を参照してください。
     #
     def get_int(section, key, opts = nil)
-      opts ||= {}
+      section, key = str(section, key)
+      opts = options(opts, :cipher, :ini, :default)
       if opts[:ini]
         api.GetProfileIntEx(section, key, opts[:default], expand_user_path(opts[:ini]))
       elsif opts[:cipher]
@@ -94,7 +199,6 @@ module SleipnirAPI
       end
     end
 
-    #
     # call-seq:
     #   write_string(section, key, data)
     #   write_string(section, key, data, :cipher => true)
@@ -104,7 +208,9 @@ module SleipnirAPI
     # * <tt>:cipher</tt> に true を指定すると暗号化してデータを書き込みます。
     #
     def write_string(section, key, data, opts = nil)
-      opts ||= {}
+      section, key = str(section, key)
+      check_data(section, key, data, String)
+      opts = options(opts, :cipher)
       if opts[:cipher]
         api.WriteProfileStringCipher(section, key, data)
       else
@@ -112,7 +218,6 @@ module SleipnirAPI
       end
     end
 
-    #
     # call-seq:
     #   write_int(section, key, data)
     #   write_int(section, key, data, :cipher => true)
@@ -122,7 +227,9 @@ module SleipnirAPI
     # * <tt>:cipher</tt> に true を指定すると暗号化してデータを書き込みます。
     #
     def write_int(section, key, data, opts = nil)
-      opts ||= {}
+      section, key = str(section, key)
+      check_data(section, key, data, Integer)
+      opts = options(opts, :cipher)
       if opts[:cipher]
         api.WriteProfileIntCipher(section, key, data)
       else
@@ -132,19 +239,51 @@ module SleipnirAPI
 
     # <ini_dir>\script.ini から指定されたキーを削除します。
     def delete(section, key)
+      section, key = str(section, key)
       api.DeleteProfileKey(section, key)
     end
 
-    # <ini_dir> から expand_path します。
+    # SleipnirAPI::Sleipnir#user_path から expand_path します。
+    #
+    # * 引数は to_s で文字列に変換されます。
+    # * 拡張子がなければ .ini を付与します。
+    #
     def expand_user_path(ini)
-      File.expand_path(ini, sleipnir.user_path)
+      raise ArgumentError, "Invalid ini file name: #{ini.inspect}" if ini.nil? or ini == ""
+      ini = ini.to_s
+      if File.extname(ini) == ""
+        ini = File.basename(ini, ".*") + ".ini"
+      end
+      File.expand_path(ini, @user_path)
     end
 
     # <ini_dir>\script.ini のパスを返します。
-    def script_ini
+    def script_ini_path
       expand_user_path("script.ini")
     end
 
+    # 指定された ini ファイルを操作する Sleipnir::Profile::Ini オブジェクトを返します。
+    #
+    #   pnir = SleipnirAPI.connect
+    #   proxy = pnir.profile.ini("Proxy.ini", :default => 123)
+    #   proxy.get_int("Proxy", "Count")
+    #
+    # See Also: #method_missing
+    def ini(name, opts = nil)
+      Ini.new(self, str(name), options(opts))
+    end
+
+    # メソッド名を ini ファイル名とみなして Sleipnir::Profile::Ini オブジェクトを返します。
+    #
+    #   pnir = SleipnirAPI.connect
+    #   proxy = pnir.profile.Proxy(:default => 123)
+    #   proxy.get_int("Proxy", "Count")
+    #
+    # See Also: #ini
+    def method_missing(mid, *args, &block)
+      ini(mid.to_s, *args, &block)
+    end
+
   end
 end
 

data/lib/sleipnir_api/profile/ini.rb

@@ -0,0 +1,202 @@
+require "sleipnir_api/util"
+require "sleipnir_api/profile/util"
+
+module SleipnirAPI
+  class Profile
+
+    # ini ファイルに対応するオブジェクトです。
+    # このオブジェクトは SleipnirAPI::Sleipnir#profile で
+    # または SleipnirAPI::Profile#ini で取得します。
+    #
+    #   pnir = SleipnirAPI.new
+    #   ini = pnir.profile("CloseURL.ini")
+    #   ini.get_string("ClosedURL2", "URL0")  #=> "http://hogehoge"
+    #
+    # #section でこの ini ファイル内のセクションに対応する SleipnirAPI::Profile::Section
+    # オブジェクトを取得できます。
+    class Ini < ProfileElement
+
+      # SleipnirAPI::Profile オブジェクトを返します。
+      attr_reader :profile
+
+      # ini ファイル名を返します。
+      # これは、SleipnirAPI::Profile#ini に指定した値をそのまま返します。
+      # フルパスを得たい場合は #path を利用してください。
+      attr_reader :name
+
+      # #get_string などに指定するデフォルトの引数を取得します。
+      # 値は #profile から引き継いでいます。
+      attr_reader :default_opts
+
+      def initialize(profile, name, default_opts = nil)
+        super(nil, default_opts)
+        @profile = profile
+        @name = (name == "" ? nil : name)
+      end
+
+      # call-seq:
+      #   list(section, keyfmt, countkey="Count")
+      #   list(section, keyfmt, countkey="Count", :default => "default value")
+      #   list(section, keyfmt, countkey="Count", :cipher => true)
+      #   list(section, keyfmt, countkey="Count", :cipher => true, :default => "default value")
+      #
+      # この ini ファイルから連番キーのデータをすべて読み込み配列で返します。
+      #
+      # 例:
+      #
+      #   pnir = SleipnirAPI.connect
+      #   proxy_ini = pnir.profile.proxy
+      #   proxy_ini.list("Proxy", "Proxy0_Title")
+      #
+      # See Also: SleipnirAPI::Profile#list
+      def list(section, keyfmt, countkey="Count", opts = nil, &block)
+        @profile.list(section, keyfmt, countkey, get_options(opts), &block)
+      end
+
+      # call-seq:
+      #   get_string(section, key)
+      #   get_string(section, key, :default => "default value")
+      #   get_string(section, key, :cipher => true)
+      #   get_string(section, key, :cipher => true, :default => "default value")
+      #
+      # この ini ファイルから string 型データを読み込みます。
+      #
+      # See Also: SleipnirAPI::Profile#get_string
+      def get_string(section, key, opts = nil)
+        @profile.get_string(section, key, get_options(opts))
+      end
+
+      # call-seq:
+      #   get_int(section, key)
+      #   get_int(section, key, :default => -1)
+      #   get_int(section, key, :cipher => true)
+      #   get_int(section, key, :cipher => true, :default => -1)
+      #
+      # この ini ファイルから int 型データを読み込みます。
+      #
+      # See Also: SleipnirAPI::Profile#get_int
+      def get_int(section, key, opts = nil)
+        @profile.get_int(section, key, get_options(opts))
+      end
+
+      # call-seq:
+      #   write_string(section, key, data)
+      #   write_string(section, key, data, :cipher => true)
+      #
+      # <ini_dir>\script.ini に string 型データを書き込みます。
+      # script.ini でない場合は SleipnirAPI::Profile::ReadOnlyError を raise します。
+      #
+      # * <tt>:cipher</tt> に true を指定すると暗号化してデータを書き込みます。
+      #
+      # See Also: SleipnirAPI::Profile#write_string
+      def write_string(section, key, data, opts = nil)
+        check_writable
+        @profile.write_string(section, key, data, write_options(opts))
+      end
+
+      # call-seq:
+      #   write_int(section, key, data)
+      #   write_int(section, key, data, :cipher => true)
+      #
+      # <ini_dir>\script.ini に int 型データを書き込みます。
+      # script.ini でない場合は SleipnirAPI::Profile::ReadOnlyError を raise します。
+      #
+      # * <tt>:cipher</tt> に true を指定すると暗号化してデータを書き込みます。
+      #
+      # See Also: SleipnirAPI::Profile#write_int
+      def write_int(section, key, data, opts = nil)
+        check_writable
+        @profile.write_int(section, key, data, write_options(opts))
+      end
+
+      # <ini_dir>\script.ini から指定されたキーを削除します。
+      #
+      # script.ini でない場合は SleipnirAPI::Profile::ReadOnlyError を raise します。
+      #
+      # See Also: SleipnirAPI::Profile#delete
+      def delete(section, key)
+        check_writable
+        @profile.delete(section, key)
+      end
+
+      # script.ini でない場合は SleipnirAPI::Profile::ReadOnlyError を raise します。
+      def check_writable
+        raise ReadOnlyError, "`#{path}' is not writable" if read_only?
+      end
+
+      # この ini ファイルのフルパスを返します。
+      def path
+        if script_ini?
+          @profile.script_ini_path
+        else
+          @profile.expand_user_path(@name)
+        end
+      end
+      alias to_s path
+
+      # <ini_dir>\script.ini なら true を返します。
+      def script_ini?
+        return true if @name.nil?
+        a = @profile.expand_user_path(@name)
+        b = @profile.script_ini_path
+        a.match(/\A#{Regexp.quote(b)}\z/i) ? true : false
+      end
+
+      # <ini_dir>\script.ini 以外なら true を返します。
+      def read_only?
+        not script_ini?
+      end
+
+      # 指定されたセクションを操作する Sleipnir::Profile::Section オブジェクトを返します。
+      #
+      #   pnir = SleipnirAPI.connect
+      #   proxy = pnir.profile.ini("Proxy.ini", :default => 123)
+      #   sec = proxy.section("Proxy")
+      #   sec.get_int("Count")
+      #
+      # See Also: #method_missing
+      def section(name, opts = nil)
+        Section.new(self, str(name), options(opts))
+      end
+
+      # メソッド名をセクション名とみなして Sleipnir::Profile::Section オブジェクトを返します。
+      #
+      #   pnir = SleipnirAPI.connect
+      #   proxy = pnir.profile.Proxy(:default => 123)
+      #   sec = proxy.Proxy
+      #   sec.get_int("Count")
+      #
+      # See Also: #section
+      def method_missing(mid, *args, &block)
+        section(mid.to_s, *args, &block)
+      end
+
+
+      def get_options(opts = nil)
+        args = options(opts, :cipher, :ini, :default)
+
+        r = {}
+        r[:default] = args.delete(:default) if args.key?(:default)
+        if script_ini?
+          r[:cipher] = args.delete(:cipher) if args.key?(:cipher)
+        else
+          r[:ini] = @name
+        end
+
+        unless args.empty?
+          raise ArgumentError, "Invalid argument: #{args.inspect} (#{path})"
+        end
+        r
+      end
+      private :get_options
+
+      def write_options(opts = nil)
+        r = get_options(opts)
+        r.delete(:default)
+        r
+      end
+      private :write_options
+
+    end
+  end
+end