ffi-stat 0.0.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75578daf5dd9e3def32adfd97911183fd408b0fc
+  data.tar.gz: d00f4b82dc49410d44f09fd9875ffe0573148f63
+SHA512:
+  metadata.gz: cb571d9904734efc83355fb4f9f40dcea233f3628bc1b921675da2e18addbee03ec15cefa59c9c99e909d65a8258325968616ef46db9473f08738a23201de02f
+  data.tar.gz: 7a6f5f8486c2113280e509a9183d99737a6d193974a7b2aef55b4166ab77b229b47e807144be472448708c2a9bdce431fa43a3600b87803524b3e0ad023939d2

data/README.md

@@ -1,12 +1,14 @@
 # FFI::Stat
 
-FFI bindings for libc stat. The primary use of this library is by other FFI libraries that require a stat struct.
+FFI platform-specific bindings for the stat struct and related functions. The
+primary use case of this library is assist other FFI libraries that require a
+stat struct.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'ffi-stat'
+    gem "ffi-stat"
 
 And then execute:
 
@@ -24,19 +26,25 @@ require "ffi/stat"
 file = "test.txt"
 fd   = $stdin.fileno
 
-FFI::Stat.stat(file)  #=> FFI::Stat::Stat
-FFI::Stat.lstat(file) #=> FFI::Stat::Stat
-FFI::Stat.fstat(fd)   #=> FFI::Stat::Stat
+if FFI::Platform.is_os("darwin")
+  FFI::Stat.stat(file)  #=> FFI::Stat::Stat
+  FFI::Stat.lstat(file) #=> FFI::Stat::Stat
+  FFI::Stat.fstat(fd)   #=> FFI::Stat::Stat
+end
 ```
 
 ## Platforms
 
-Currently FFI::Stat has only been tested and known to work on Mac OS X Mountain Lion. Support for other OS platforms are on the roadmap.
+FFI::Stat has support for the stat struct on the following platforms:
+
+* x86_64-darwin
+* x86_64-linux
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. Ensure all tests pass (`rake test`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/ffi-stat.gemspec

@@ -1,23 +1,23 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ffi/stat/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "ffi-stat"
-  gem.version       = FFI::Stat::VERSION
-  gem.authors       = ["Adam Tanner"]
-  gem.email         = ["adam@adamtanner.org"]
-  gem.description   = %q{FFI bindings for libc stat}
-  gem.summary       = %q{FFI bindings for libc stat}
-  gem.homepage      = "https://github.com/adamtanner/ffi-stat"
+Gem::Specification.new do |spec|
+  spec.name          = "ffi-stat"
+  spec.version       = "0.2.0"
+  spec.authors       = ["Adam Tanner"]
+  spec.email         = ["adam@adamtanner.org"]
+  spec.description   = %q{ Ruby FFI bindings for stat }
+  spec.summary       = %q{ Ruby FFI bindings for stat }
+  spec.homepage      = "https://github.com/adamtanner/ffi-stat"
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
 
-  gem.add_dependency "ffi"
-
-  gem.add_development_dependency "rake"
+  spec.add_dependency "ffi"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
 end

data/lib/ffi/stat/x86_64-darwin/stat.rb

@@ -0,0 +1,58 @@
+module FFI::Stat
+  module Native
+    extend FFI::Library
+
+    ffi_lib FFI::Library::LIBC
+
+    attach_function :stat,  [ :string, :pointer ], :int
+    attach_function :lstat, [ :string, :pointer ], :int
+    attach_function :fstat, [ :int, :pointer    ], :int
+  end
+
+  class Timespec < FFI::Struct
+    layout :tv_sec,  :time_t,
+           :tv_nsec, :long
+  end
+
+  class Stat < FFI::Struct
+    layout :st_dev,       :dev_t,
+           :st_ino,       :uint32,
+           :st_mode,      :mode_t,
+           :st_nlink,     :nlink_t,
+           :st_uid,       :uid_t,
+           :st_gid,       :gid_t,
+           :st_rdev,      :dev_t,
+           :st_atimespec, FFI::Stat::Timespec,
+           :st_mtimespec, FFI::Stat::Timespec,
+           :st_ctimespec, FFI::Stat::Timespec,
+           :st_size,      :off_t,
+           :st_blocks,    :blkcnt_t,
+           :st_blksize,   :blksize_t,
+           :st_flags,     :uint32,
+           :st_gen,       :uint32
+  end
+
+  def self.stat(path)
+    stat = FFI::Stat::Stat.new
+
+    FFI::Stat::Native.stat(path, stat.pointer)
+
+    stat
+  end
+
+  def self.lstat(path)
+    stat = FFI::Stat::Stat.new
+
+    FFI::Stat::Native.lstat(path, stat.pointer)
+
+    stat
+  end
+
+  def self.fstat(fd)
+    stat = FFI::Stat::Stat.new
+
+    FFI::Stat::Native.fstat(fd, stat.pointer)
+
+    stat
+  end
+end

data/lib/ffi/stat/x86_64-linux/stat.rb

@@ -0,0 +1,23 @@
+module FFI::Stat
+  class Timespec < FFI::Struct
+    layout :tv_sec,  :time_t,
+           :tv_nsec, :long
+  end
+
+  class Stat < FFI::Struct
+    layout :st_dev,     :dev_t,
+           :st_ino,     :ino_t,
+           :st_nlink,   :nlink_t,
+           :st_mode,    :mode_t,
+           :st_uid,     :uid_t,
+           :st_gid,     :gid_t,
+           :__pad0,     :int,
+           :st_rdev,    :dev_t,
+           :st_size,    :off_t,
+           :st_blksize, :blksize_t,
+           :st_blocks,  :blkcnt_t,
+           :st_atimespec, FFI::Stat::Timespec,
+           :st_mtimespec, FFI::Stat::Timespec,
+           :st_ctimespec, FFI::Stat::Timespec
+  end
+end

data/lib/ffi/stat.rb

@@ -1,33 +1,6 @@
 require "ffi"
 
-require "ffi/stat/timespec"
-require "ffi/stat/stat"
-require "ffi/stat/library"
-
-module FFI
-  module Stat
-    def self.stat(path)
-      stat_struct = FFI::Stat::Stat.new
-
-      FFI::Stat::Library.stat(path, stat_struct.pointer)
-
-      stat_struct
-    end
-
-    def self.lstat(path)
-      stat_struct = FFI::Stat::Stat.new
-
-      FFI::Stat::Library.lstat(path, stat_struct.pointer)
-
-      stat_struct
-    end
-
-    def self.fstat(fd)
-      stat_struct = FFI::Stat::Stat.new
-
-      FFI::Stat::Library.fstat(fd, stat_struct.pointer)
-
-      stat_struct
-    end
-  end
+module FFI::Stat
 end
+
+require "ffi/stat/#{FFI::Platform::NAME}/stat"

data/spec/stat_spec.rb

@@ -4,79 +4,21 @@ require "ffi/stat"
 
 describe FFI::Stat do
   it "can stat a file" do
-    file = File.expand_path __FILE__
-
-    stat_struct = FFI::Stat.stat file
-
-    stat_struct[:st_dev       ].wont_be_nil
-    stat_struct[:st_ino       ].wont_be_nil
-    stat_struct[:st_mode      ].wont_be_nil
-    stat_struct[:st_nlink     ].wont_be_nil
-    stat_struct[:st_uid       ].wont_be_nil
-    stat_struct[:st_gid       ].wont_be_nil
-    stat_struct[:st_rdev      ].wont_be_nil
-    stat_struct[:st_size      ].wont_be_nil
-
-    stat_struct[:st_atimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_atimespec][:tv_nsec].wont_be_nil
-    stat_struct[:st_mtimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_mtimespec][:tv_nsec].wont_be_nil
-    stat_struct[:st_ctimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_ctimespec][:tv_nsec].wont_be_nil
-
-    stat_struct[:st_blksize   ].wont_be_nil
-    stat_struct[:st_blocks    ].wont_be_nil
-  end
-
-  it "can lstat a file" do
-    file = File.expand_path __FILE__
-
-    stat_struct = FFI::Stat.lstat file
-
-    stat_struct[:st_dev       ].wont_be_nil
-    stat_struct[:st_ino       ].wont_be_nil
-    stat_struct[:st_mode      ].wont_be_nil
-    stat_struct[:st_nlink     ].wont_be_nil
-    stat_struct[:st_uid       ].wont_be_nil
-    stat_struct[:st_gid       ].wont_be_nil
-    stat_struct[:st_rdev      ].wont_be_nil
-    stat_struct[:st_size      ].wont_be_nil
-
-    stat_struct[:st_atimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_atimespec][:tv_nsec].wont_be_nil
-    stat_struct[:st_mtimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_mtimespec][:tv_nsec].wont_be_nil
-    stat_struct[:st_ctimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_ctimespec][:tv_nsec].wont_be_nil
-
-    stat_struct[:st_blksize  ].wont_be_nil
-    stat_struct[:st_blocks   ].wont_be_nil
-  end
-
-  it "can fstat a file descriptor" do
-    file = File.open(__FILE__)
-
-    stat_struct = FFI::Stat.fstat file.fileno
-
-    stat_struct[:st_dev       ].wont_be_nil
-    stat_struct[:st_ino       ].wont_be_nil
-    stat_struct[:st_mode      ].wont_be_nil
-    stat_struct[:st_nlink     ].wont_be_nil
-    stat_struct[:st_uid       ].wont_be_nil
-    stat_struct[:st_gid       ].wont_be_nil
-    stat_struct[:st_rdev      ].wont_be_nil
-    stat_struct[:st_size      ].wont_be_nil
-
-    stat_struct[:st_atimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_atimespec][:tv_nsec].wont_be_nil
-    stat_struct[:st_mtimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_mtimespec][:tv_nsec].wont_be_nil
-    stat_struct[:st_ctimespec][:tv_sec ].wont_be_nil
-    stat_struct[:st_ctimespec][:tv_nsec].wont_be_nil
-
-    stat_struct[:st_blksize   ].wont_be_nil
-    stat_struct[:st_blocks    ].wont_be_nil
-
-    file.close
+    skip unless FFI::Stat.respond_to?(:stat)
+
+    ffi_stat = FFI::Stat.stat(__FILE__)
+    rb_stat = File.stat(__FILE__)
+
+    ffi_stat[:st_dev].must_equal(rb_stat.dev)
+    ffi_stat[:st_ino].must_equal(rb_stat.ino)
+    ffi_stat[:st_mode].must_equal(rb_stat.mode)
+    ffi_stat[:st_nlink].must_equal(rb_stat.nlink)
+    ffi_stat[:st_uid].must_equal(rb_stat.uid)
+    ffi_stat[:st_gid].must_equal(rb_stat.gid)
+    ffi_stat[:st_rdev].must_equal(rb_stat.rdev)
+
+    ffi_stat[:st_size].must_equal(rb_stat.size)
+    ffi_stat[:st_blksize].must_equal(rb_stat.blksize)
+    ffi_stat[:st_blocks].must_equal(rb_stat.blocks)
   end
 end

metadata

@@ -1,49 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: ffi-stat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Tanner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: FFI bindings for libc stat
+description: ' Ruby FFI bindings for stat '
 email:
 - adam@adamtanner.org
 executables: []
@@ -57,40 +66,32 @@ files:
 - Rakefile
 - ffi-stat.gemspec
 - lib/ffi/stat.rb
-- lib/ffi/stat/library.rb
-- lib/ffi/stat/stat.rb
-- lib/ffi/stat/timespec.rb
-- lib/ffi/stat/version.rb
+- lib/ffi/stat/x86_64-darwin/stat.rb
+- lib/ffi/stat/x86_64-linux/stat.rb
 - spec/stat_spec.rb
 homepage: https://github.com/adamtanner/ffi-stat
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3092432383365459650
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3092432383365459650
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: FFI bindings for libc stat
+specification_version: 4
+summary: Ruby FFI bindings for stat
 test_files:
 - spec/stat_spec.rb

data/lib/ffi/stat/library.rb

@@ -1,12 +0,0 @@
-module FFI
-  module Stat
-    module Library
-      extend FFI::Library
-      ffi_lib FFI::Library::LIBC
-
-      attach_function :stat,  [ :string, :pointer ], :int
-      attach_function :lstat, [ :string, :pointer ], :int
-      attach_function :fstat, [ :int, :pointer    ], :int
-    end
-  end
-end

data/lib/ffi/stat/stat.rb

@@ -1,21 +0,0 @@
-module FFI
-  module Stat
-    class Stat < FFI::Struct
-      layout :st_dev,       :dev_t,
-             :st_ino,       :ino_t,
-             :st_mode,      :mode_t,
-             :st_nlink,     :nlink_t,
-             :st_uid,       :uid_t,
-             :st_gid,       :gid_t,
-             :st_rdev,      :dev_t,
-             :st_atimespec, FFI::Stat::Timespec,
-             :st_mtimespec, FFI::Stat::Timespec,
-             :st_ctimespec, FFI::Stat::Timespec,
-             :st_size,      :off_t,
-             :st_blocks,    :quad_t,
-             :st_blksize,   :ulong,
-             :st_flags,     :ulong,
-             :st_gen,       :ulong
-    end
-  end
-end

data/lib/ffi/stat/timespec.rb

@@ -1,8 +0,0 @@
-module FFI
-  module Stat
-    class Timespec < FFI::Struct
-      layout :tv_sec,  :long,
-             :tv_nsec, :long
-    end
-  end
-end

data/lib/ffi/stat/version.rb

@@ -1,5 +0,0 @@
-module FFI
-  module Stat
-    VERSION = "0.0.2"
-  end
-end