mincore 0.0.9.pre → 0.0.9.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19f2d12d2696de6c950623e5de70a1f3263d99d4
+  data.tar.gz: 1e99083d29131d7fc9e224f98dfe4ada3970ddc1
+SHA512:
+  metadata.gz: 55ef0831de1e5288af669766f250af6a04ef6ac224c688c1faae2d7e2936669c43b6b01e789a64689fa96c70e465f705423457d9197aba5cddf80b5c6cbf5dc3
+  data.tar.gz: 83cb92caf55e88c4d8d7bc0b3ad4e0ce7a44faa4bfc4a99fa372df82dcc26957b7547ca43e4e9a7f90d7b7f00a91d5bcfb40da50a5c126dc332df23cf92ca6ba

data/.gitignore

@@ -3,3 +3,5 @@ scratch
 *.gem
 Gemfile.lock
 gems/
+.yardoc/
+doc/

data/.yardopts

@@ -0,0 +1,7 @@
+--main README.md
+--markup markdown
+-
+CHANGELOG.md
+CONTRIBUTING.md
+LICENSE.md
+README.md

data/README.md

@@ -1,19 +1,60 @@
-ruby-mincore
-============
+ruby-mincore - Ruby bindings for Linux cache manipulation
+=========================================================
 [![Gem Version](https://badge.fury.io/rb/mincore.png)](http://badge.fury.io/rb/mincore)
-[![Build Status](https://travis-ci.org/noushi/ruby-mincore.png?branch=master)](https://travis-ci.org/noushi/ruby-mincore)
+|
+[![Build Status](https://travis-ci.org/noushi/ruby-mincore.png)](https://travis-ci.org/noushi/ruby-mincore)
+| 
 [![Code Climate](https://codeclimate.com/github/noushi/ruby-mincore.png)](https://codeclimate.com/github/noushi/ruby-mincore)
+| 
 [![Dependency Status](https://gemnasium.com/noushi/ruby-mincore.png)](https://gemnasium.com/noushi/ruby-mincore)
 
-Ruby bindings for Linux cache manipulation.
+`mincore` provides Ruby bindings for Linux cache manipulation, including cache inspection and deletion for a specific file.
 
 This project is heavily inspired from [Feh/nocache](http://github.com/Feh/nocache).
 
+Usage
+=====
+
+Currently, `mincore` features are implemented as class methods:
+
+    size=File.PAGESIZE
+    # 4096 
+    
+    File.open("/path/to/file").numpages #The only instance method
+    # 5
+    
+    File.mincore("/path/to/file")
+    # [true, true, false, false, true]
+    
+    File.cachedel("/path/to/file")
+    # 0
+    
+    File.mincore("/path/to/file")
+    # [true, true, false, false, true]
+    
+    File.cachedel("/path/to/file", 2)
+    # 0
+    
+    File.mincore("/path/to/file")
+    # [true, true, false, false, true]
+    
+    File.cachedel("/path/to/file", 2)
+    # 0
+    
+    File.mincore("/path/to/file")
+    # [false, false, false, false, false]
+
+This is an illustration of the fact that `cachedel` may or may not actually purge cached pages even if run multiple times (through the second parameter).
+
+Full documentation available in the source code ^H^H, [Ruby Doc](http://rubydoc.info/gems/mincore/File).
+
+
 
 Status & Limitations
 ====================
 
 Currently, the File class is extended as such:
+
 - `mincore(filename)` is exported to Ruby in the form of an array of booleans corresponding to each page of the file.
 - `cachedel(filename, count=1)` calls `posix_fadvise(2)` to purge all file pages from the cache
 - `PAGESIZE` is a simple helper that returns the value of PAGESIZE (4KB on Intel)
@@ -22,9 +63,19 @@ The bindings are implemented using Ruby Inline, instead of the classic mkmf ext
 
 There is a gem module generated, and the code is still beta.
 
-Since `File.cachedel()` isn't guaranteed to work (no matter how many time you call it), the `test_cachedel_non_empty_file` most always succeeds without properly asserting that `posix_fadvise()` has worked.
+Since `File.cachedel()` isn't guaranteed to work (no matter how many time you call it), the `test_cachedel_non_empty_file` most always succeeds without properly asserting that `posix_fadvise()` has worked. 
 
 Also, the tests use a `./writable_tmp_dir/` directory to store the temporary test files. `/tmp` can't be used since it's 
 usually a ramfs, and files will always be in cache, until they're deleted.
 
 
+
+Contributing
+============
+Contributions are most welcome, you know the drill:
+
+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

data/lib/mincore.rb

@@ -2,6 +2,7 @@ require 'inline'
 
 # The File mincore extension
 class File
+  private 
   def self._common_code(builder)
     builder.include("<stdio.h>")
     builder.include("<stdlib.h>")
@@ -17,7 +18,6 @@ class File
     builder.prefix("#define exiterr(s) { perror(s); exit(-1); }")
   end
 
-
   inline do |builder|    
     builder.include("<unistd.h>")
     builder.c_raw_singleton "
@@ -141,7 +141,13 @@ static VALUE _cachedel(char *filename, int count) {
 C_CODE
   end
 
+  public
+
   # Returns the number of system pages required to store file in memory
+  # @example Sample run - on a file of size 20KB
+  #    File.open("/path/to/some/file").numpages #=> 5
+  # 
+  # @return [Int] number of cacheable pages
   def numpages
     pagesize = self.class.PAGESIZE
     (self.stat.size + pagesize -1 ) / pagesize
@@ -150,14 +156,12 @@ C_CODE
 
   # Attempts to delete cached pages of a file, one or more times
   # 
-  # Example:
-  #    >> File.cachedel("/path/to/useless/file", 2)
-  #    => 0
+  # @example Sample run - file pages would or would not get flushed
+  #    File.cachedel("/path/to/useless/file", 2) #=> 0
   # 
-  # Arguments:
-  #   filename: (String)
-  #   count: (Int)
-  #
+  # @param filename [String] file name
+  # @param count [Int] times `posix_fadvise()` will be run
+  # @return [Int] execution status
   def self.cachedel(filename, count=1) 
     self._cachedel(filename, count)
   end
@@ -166,22 +170,21 @@ C_CODE
   # Status is provided as a boolean array of size
   # ( filesize + PAGESIZE -1 ) / PAGESIZE
   #
-  # Example: 
-  #    >> File.mincore("/path/to/important/file")
-  #    => [true, true, true....]
-  # 
-  # Arguments:
-  #   filename: (String)
-  #
-  def self.mincore(*args)
-    self._mincore(*args)
+  # @example Sample run - on a file of size 20KB
+  #    File.mincore("/path/to/important/file") #=> [true, true, true, false, false]
+  #    
+  # @param filename [String] file name
+  # @return [Int] execution status
+  def self.mincore(filename)
+    self._mincore(filename)
   end
 
-  # get system pagesize (4096 on Intel)
+  # get system page size (4096 on Intel)
   # 
-  # Example:
-  #    >> File.PAGESIZE
-  #    => 4096
+  # @example - On Intel machine
+  #    File.PAGESIZE #=> 4096
+  #
+  # @return [Int] the page size
   def self.PAGESIZE
     self._PAGESIZE
   end

data/mincore.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name        = 'mincore'
-  s.version     = '0.0.9.pre'
+  s.version     = '0.0.9.1.pre'
   s.date        = '2013-11-10'
 
   s.homepage    = 'http://github.com/noushi/ruby-mincore'
   s.summary     = "Ruby bindings for Linux cache manipulation"
   s.description = <<-DESC
-    micore provides Ruby bindings for Linux cache manipulation, 
+    mincore provides Ruby bindings for Linux cache manipulation, 
     including cache inspection and deletion for a specific file.
   DESC
   s.license       = 'GPL-2'

metadata

@@ -1,66 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mincore
-version: !ruby/object:Gem::Version 
-  hash: -2045603333
-  prerelease: 6
-  segments: 
-  - 0
-  - 0
-  - 9
-  - pre
-  version: 0.0.9.pre
+version: !ruby/object:Gem::Version
+  version: 0.0.9.1.pre
 platform: ruby
-authors: 
+authors:
 - Reda NOUSHI
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-11-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: RubyInline
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 45
-        segments: 
-        - 3
-        - 10
-        - 1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
         version: 3.10.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: RubyInline
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 45
-        segments: 
-        - 3
-        - 10
-        - 1
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+- !ruby/object:Gem::Dependency
+  name: RubyInline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
         version: 3.10.1
   type: :development
-  version_requirements: *id002
-description: "    micore provides Ruby bindings for Linux cache manipulation, \n    including cache inspection and deletion for a specific file.\n"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+description: "    mincore provides Ruby bindings for Linux cache manipulation, \n
+  \   including cache inspection and deletion for a specific file.\n"
 email: reda_noushi@yahoo.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - README.md
 - Rakefile
@@ -72,41 +59,31 @@ files:
 - test/test_helper.rb
 - test/tinify_test.rb
 homepage: http://github.com/noushi/ruby-mincore
-licenses: 
+licenses:
 - GPL-2
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby bindings for Linux cache manipulation
-test_files: 
+test_files:
 - test/mincore_test.rb
 - test/test_helper.rb
 - test/tinify_test.rb
+has_rdoc: