invfs 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2909cffa456fdd3f5b4fc6efdbc4cfaa07f1faf30db565da868af67233bf9635
-  data.tar.gz: f5db8163c2fb5533c7fb72deab583d66c3b54d8bb29058c426d68733d2020821
+  metadata.gz: 5ba520faaa919d8053ed90c0e4f1a83566a0bfb15dc3dbc2a556a335d7c16922
+  data.tar.gz: ade81666d1041d7e2789929b03297592119767e7b9f9280775fcf7bd655127f4
 SHA512:
-  metadata.gz: e4126c3039e12664d9564ff9877dafc8694777f91d286f3fe800667ed7df2ce8379d2d5488bee2c966bf7b7e8ff600368e6bab47a75ec98ee73faa13a3e1cfba
-  data.tar.gz: 8b05d884e52a39537978f395e886f975f87a946e9ed38dcd04a145e9528c6408c2edf4582aab535d8a9f39a00a59ba1832c0462aab86bdcaa2671bddca9c0e56
+  metadata.gz: 69e2d22350e08b9ce911e75a071688f78916e30d5b821ae6b229e3c3a91c8cd082836d8a70fc02f92f776487732a6acb18625e70ba3697b4ded4c88fadde7222
+  data.tar.gz: f21cfaa41d7f266a24b737ee5665647735d67bf0b5b28e5d5a3f2594bab9bdf9ef0ff4b84ffe789ba21702a718965019e2f6e0e92120cac6e4c2692fd7a95cbb

data/README.md

@@ -3,7 +3,7 @@
 ruby の ``require`` に仮想ファイルシステム (VFS; Virtual Filesystem) 対応機能を追加します。
 
   * package name: invfs <https://github.com/dearblue/ruby-invfs>
-  * version: 0.2
+  * version: 0.3
   * production quality: CONCEPT, EXPERIMENTAL, UNSTABLE
   * license: BSD-2-clause License
   * author: dearblue <mailto:dearblue@users.noreply.github.com>
@@ -89,7 +89,7 @@ VFS オブジェクトは ``$:`` に追加する、利用者定義のロード
   * ``.size(path) -> integer``
   * ``.read(path) -> string as binary``
 
-実際にどのように定義すればいいのかについては、[lib/invfs/zip.rb](lib/invfs/zip.rb) あるいは [lib/invfs.rb](lib.invfs.rb) で定義されている ``InVFS::UnionFS``、``InVFS::StringMapFS`` を参考にして下さい。
+実際にどのように定義すればいいのかについては、[lib/invfs/zip.rb](lib/invfs/zip.rb) あるいは [lib/invfs.rb](lib/invfs.rb) で定義されている ``InVFS::UnionFS``、``InVFS::StringMapFS`` を参考にして下さい。
 
 ### ``.to_path() -> string``
 
@@ -122,6 +122,41 @@ VFS からファイルを読み込むためのメソッドです。
 ***文字列、または nil を返して下さい。***
 
 
+## VFS ハンドラ
+
+``$:`` にファイルを追加した場合、``require`` 時に VFS と解釈可能であれば、内部的にそのファイルを VFS として扱われる機能です。
+
+前にあった例を書き換えた場合の利用例を示します。(2) の部分です。
+
+```ruby
+require "invfs/zip"   # (1)
+
+$: << "mybox.zip"     # (2)
+
+require "mybox/core"  # (3)
+
+MyBox.sayhello!
+```
+
+VFS ハンドラを利用したい場合は、``.probe`` と ``.open`` メソッドを持ったオブジェクトを ``InVFS.regist`` で登録して下さい。
+
+```ruby
+class VFSHandler
+  def VFSHandler.probe(file)
+    # check available as VFS
+  end
+
+  def VFSHandler.open(file)
+    # open as VFS
+  end
+
+  InVFS.regist self
+end
+```
+
+実際にどのようにつかっているのかについては、[lib/invfs.rb](lib/invfs.rb) を見て下さい。
+
+
 ## Environment Variables (環境変数について)
 
   * ``RUBY_REQUIRE_INVFS_MAX_LOADSIZE`` :: 読み込みファイルの最大ファイルサイズの指定
@@ -175,17 +210,3 @@ VFS からファイルを読み込むためのメソッドです。
 
     ``caller_locations`` で VFS の直接確認が出来るようにするためには ruby の
     C コードに手を入れなきゃなんないし諦める。
-
-  * ``$:`` にファイルを指定した場合、InVFS の VFS mapper が自動で VFS に置き換えるようにするか?
-
-    実現させると、以下のことが可能となる:
-
-    ```shell
-    $ ruby -I mybox.zip -r invfs/zip -r mybox/core -e '......'
-    ```
-
-    これは、以下と同等である:
-
-    ```shell
-    $ ruby -r invfs/zip -e '$: << InVFS.zip("mybox.zip"); require "mybox/core"; ......'
-    ```

data/lib/invfs/zip.rb

@@ -3,73 +3,112 @@
 require "zip/filesystem"
 require_relative "../invfs"
 
+using InVFS::Extensions
+
 def InVFS.zip(*args)
   InVFS::Zip.new(*args)
 end
 
-class InVFS::Zip
-  attr_reader :path, :zip, :zipfile
+module InVFS
+  class Zip
+    attr_reader :path, :zip, :zipfile
 
-  def initialize(path)
-    @path = String(path)
-    @zip = Zip::File.open(@path)
-    @zipfile = @zip.file
-  end
+    def initialize(path)
+      @path = String(path)
+      @zip = ::Zip::File.open(@path)
+      @zipfile = @zip.file
+    end
 
-  #
-  # call-seq:
-  #   to_path -> string
-  #
-  # REQUIRED method for VFS.
-  #
-  # This value MUST be not modifying in each objects.
-  #
-  def to_path
-    path
-  end
+    #
+    # call-seq:
+    #   to_path -> string
+    #
+    # REQUIRED method for VFS.
+    #
+    # This value MUST be not modifying in each objects.
+    #
+    def to_path
+      path
+    end
 
-  #
-  # call-seq:
-  #   file?(path) -> true OR false (OR nil)
-  #
-  # REQUIRED method for VFS.
-  #
-  def file?(path)
-    zipfile.file?(path)
-  end
+    #
+    # call-seq:
+    #   file?(path) -> true OR false (OR nil)
+    #
+    # REQUIRED method for VFS.
+    #
+    def file?(path)
+      zipfile.file?(path)
+    end
 
-  #
-  # call-seq:
-  #   size(path) -> integer for file size
-  #
-  # REQUIRED method for VFS.
-  #
-  def size(path)
-    zipfile.size(path)
-  end
+    #
+    # call-seq:
+    #   size(path) -> integer for file size
+    #
+    # REQUIRED method for VFS.
+    #
+    def size(path)
+      zipfile.size(path)
+    end
 
-  #
-  # call-seq:
-  #   read(path) -> string
-  #
-  # REQUIRED method for VFS.
-  #
-  def read(path)
-    zipfile.read(path)
-  end
+    #
+    # call-seq:
+    #   read(path) -> string
+    #
+    # REQUIRED method for VFS.
+    #
+    def read(path)
+      zipfile.read(path)
+    end
 
-  #
-  # optional method for VFS.
-  #
-  def to_s
-    %(#{path} (#{self.class}))
-  end
+    #
+    # optional method for VFS.
+    #
+    def to_s
+      %(#{path} (#{self.class}))
+    end
+
+    def inspect
+      %(#<#{self.class}:#{path}>)
+    end
 
-  def inspect
-    %(#<#{self.class}:#{path}>)
+    def pretty_print(q)
+      q.text inspect
+    end
   end
 
-  def pretty_print(q)
-    q.text inspect
+  class Zip
+    #
+    # VFS Handler Methods
+    ;
+
+    #
+    # call-seq:
+    #   probe(file) -> true or false
+    #
+    # REQUIRED method for VFS Handler.
+    #
+    # Check available as VFS.
+    #
+    def Zip.probe(file)
+      file.readat(0, 4) == "PK\x03\x04"
+    end
+
+    #
+    # call-seq:
+    #   open(file) -> VFS object
+    #
+    # REQUIRED method for VFS Handler.
+    #
+    # Open as VFS.
+    #
+    def Zip.open(file)
+      new file
+    end
+
+    #
+    # Regist handler as VFS.
+    #
+    InVFS.regist self
   end
 end

data/lib/invfs.rb

@@ -75,6 +75,20 @@ module InVFS
       end
     end
 
+    refine BasicObject do
+      def it_a_file?
+        false
+      end
+    end
+
+    [::String, ::File, ::Dir, ::Pathname].each do |klass|
+      refine klass do
+        def it_a_file?
+          File.file?(self)
+        end
+      end
+    end
+
     [::String, ::File, ::Dir].each do |klass|
       refine klass do
         def file?(path)
@@ -83,6 +97,15 @@ module InVFS
       end
     end
 
+    [::String, ::File, ::Pathname].each do |klass|
+      refine klass do
+        def readat(off, size = nil, buf = "".b)
+          buf.replace File.binread(self, size, off)
+          buf
+        end
+      end
+    end
+
     refine Object do
       if Object.const_defined?(:DEBUGGER__)
         BREAKPOINT_SET = {}
@@ -184,10 +207,43 @@ module InVFS
         dir += "/" unless dir.empty? || dir[-1] == "/"
         (a, b, c) = lib.partition(dir)
         next unless a.empty? && !b.empty? && !c.empty?
+        next unless vfs = mapvfs(vfs)
         yield(vfs, c)
       end
     else
-      $:.each { |vfs| yield(vfs, lib) }
+      $:.each do |vfs|
+        next unless vfs = mapvfs(vfs)
+        yield(vfs, lib)
+      end
+    end
+
+    nil
+  end
+
+  @mapped_list = {}
+  @handler_list = []
+
+  def InVFS.regist(handler)
+    unless handler.respond_to?(:probe) && handler.respond_to?(:open)
+      raise "%s - #<%s:0x08x>" %
+        ["need ``.probe'' and ``.open'' methods for vfs handler",
+         handler.class, handler.object_id]
+    end
+
+    @handler_list << handler
+
+    nil
+  end
+
+  def InVFS.mapvfs(vfs)
+    return vfs unless vfs.it_a_file?
+
+    v = @mapped_list[vfs]
+    return v if v
+
+    @handler_list.each do |handler|
+      next unless handler.probe(vfs)
+      return @mapped_list[vfs] = handler.open(vfs)
     end
 
     nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invfs
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - dearblue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2018-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip