fsfifo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1873cb49b135d37167ccf99dee689680af2db32e
+  data.tar.gz: 7f444b3acba163fcaf2a559c715531829bc36cc6
+SHA512:
+  metadata.gz: c392f2a447179efda3885bef1599ba26826890fc5a326f000bfec3b46f96f3c0126312d23a78610e5562b8c3a3c4d08cccdee3b7f38ad10148609d67a0770cdb
+  data.tar.gz: f05d3151607942b4fceb4638e91200813140182ac67d8976fa672d3defe7ed0ec84d6b45e45fc1a88f8a1edfddb3e6c2f3dff6ae2e04d29735f6ed62a5e48109

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.3.5"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov-rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 YAMAMOTO, Masayuki
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fsfifo"
+  gem.homepage = "http://github.com/mephistobooks/fsfifo"
+  gem.license = "MIT"
+  gem.summary = %Q{Fixed size FIFO.}
+  gem.description = %Q{Fixed size FIFO, LIFO, and Array.}
+  gem.email = "martin.route66.blues+github@gmail.com"
+  gem.authors = ["YAMAMOTO, Masayuki"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  #test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/**/test*.rb'
+  test.verbose = true
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+#  test.libs << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#  test.rcov_opts << '--exclude "gems/*"'
+#end
+#require 'simplecov'
+#require 'simplecov-rcov'
+#SimpleCov.start if ENV["COVERAGE"]  # to do this, type COVERAGE=true rake test
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fsfifo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/ReadMe.md

@@ -0,0 +1,74 @@
+# fsfifo ReadMe
+
+## Fixed Size FIFO, LIFO, Array lib.
+
+fsfifo.rb defines FSFIFO, which is the fixed size FIFO (Queue).
+
+This extends the built-in Array so you can easily understand it. (fsfifo.rb also defines FSLIFO and FSArray, and FSArray is the most general class)
+
+
+## Usage
+
+Do ```[sudo] gem install fsfifo``` and ```require 'fsfifo'``` for preparation.
+
+### new
+
+Just ```FSFIFO.new(4)``` or ```FSFIFO.new( size: 4 )``` and then you can create a FIFO whose size is 4:
+
+```
+>>fsf = FSFIFO.new( 4 )
+=> []
+>> fsf.size
+=> 0
+>> fsf.fifosize
+=> 4
+```
+
+### size
+Here, FSFIFO#size means the number of elements and FSFIFO#fifosize means the size of FIFO. You can also change the size of FIFO by FSFIFO#resize.
+
+### operation
+
+And you can push objects like this:
+
+```
+>> fsf.push( 1 )
+=> [1]
+
+>> fsf.push( 2 )
+=> [1, 2]
+
+>> fsf.push( 3 )
+=> [1, 2, 3]
+
+>> fsf.push( 4 )
+=> [1, 2, 3, 4]
+
+>> fsf.push( 5 )
+=> [2, 3, 4, 5]
+```
+
+You can also shift and resize.
+
+```
+>> fsf
+=> [2, 3, 4, 5]
+>> fsf.shift
+=> 2
+>> fsf
+=> [3, 4, 5]
+>> fsf.resize( 2 )
+=> [3]
+>> fsf
+=> [4, 5]
+>> fsf.push( 6 )
+=> [5, 6]
+```
+
+
+## License
+
+MIT License.
+
+
+# End

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/fsfifo.rb

@@ -0,0 +1,134 @@
+#
+# filename: fs_fifo.rb
+#
+#
+
+
+#
+# Fixed Size FIFO, LIFO, and Array.
+#
+#
+class FSArray < Array
+
+  #
+  # FSArray#new( n )
+  # FSArray#new( size: n, of_enbl: true, of_proc: Proc.new{...} )
+  #
+  def initialize( args = {} )
+
+    if args.class == Fixnum
+      args = { size: args, wm_size: args }
+    end
+
+    @opt = {
+      :size => 1,
+      :of_enbl => false,
+      :of_proc => Proc.new{},
+      :uf_enbl => false,
+      :uf_proc => Proc.new{},
+      :push_enbl => false, #TODO.
+      :push_proc => Proc.new{},
+      :wm_size => 1,
+      :wm_enbl => false,
+      :wm_proc => Proc.new{},
+    }.merge( args )
+
+    @shifted = nil  #TODO.
+
+    #
+    super( )
+
+  end
+
+  #
+  # Over/underflow callback methods getter/setter, etc.
+  #
+  def of_proc; @opt[:of_proc]; end
+  def of_proc=( newp ); @opt[:of_proc] = newp; end
+  def of_enable; @opt[:of_enbl] = true; end
+  def of_disable; @opt[:of_enbl] = false; end
+  def of_enable?; @opt[:of_enbl] ; end
+
+  def uf_proc; @opt[:uf_proc]; end
+  def uf_proc=( newp ); @opt[:uf_proc] = newp; end
+  def uf_enable; @opt[:uf_enbl] = true; end
+  def uf_disable; @opt[:uf_enbl] = false; end
+  def uf_enable?; @opt[:uf_enbl] ; end
+
+  #
+  # FIFO and data size-related methods.
+  #
+  def fifosize; @opt[:size]; end
+  # Array#size indicates the number of elements in fifo.
+  def resize( n )
+    ret = []
+    @opt[:wm_size] = n if @opt[:size] == @opt[:wm_size]
+    @opt[:size] = n
+    ret << self.shift_org while self.size > n
+
+    return ret
+  end
+ 
+  #
+  alias :shift_org :shift
+  alias :push_org :push
+
+  #
+  # shift and push - main methods of FSFIFO.
+  #
+  def shift
+    ret = shift_org
+
+    # callback method when under flow is enabled.
+    if self.size == 0
+      if @opt[:uf_enbl]
+        @opt[:uf_proc].call
+      end
+    end
+
+    return ret
+  end
+
+  def push( obj )
+
+    #
+    push_org( obj )
+   
+    #
+    of_called = false
+    wm_called = false
+    while self.size > @opt[:size]
+      #
+      shift_org
+
+      # overflow callback.
+      if @opt[:of_enbl] and not(of_called)
+        @opt[:of_proc].call
+        of_called = true
+      end
+
+      # TODO.watermark callback.
+      if @opt[:wm_enbl] and not(wm_called)
+        @opt[:wm_proc].call
+        wm_called = true
+      else
+        #raise ""
+      end
+    end
+
+    return self
+  end
+
+end
+
+
+class FSFIFO < FSArray
+  undef pop
+end
+
+class FSLIFO < FSArray
+  undef shift
+end
+
+
+#### endof filename: fixed_array.rb

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+require 'simplecov-rcov'
+SimpleCov.start if ENV["COVERAGE"]  # to do this, type COVERAGE=true rake test
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fsfifo'
+
+class Test::Unit::TestCase
+end

data/test/test_fsfifo.rb

@@ -0,0 +1,205 @@
+#
+# filename: test-fs_array.rb
+#
+#
+
+# Unit Test Lib.
+#require "rubygems"
+#gem "test-unit"
+#require "test/unit"
+require 'helper'
+require 'test/unit'
+
+# required lib.
+#require 'something'
+
+# Testee.
+require "fsfifo"
+
+
+# Test Cases.
+class TestFSArray < Test::Unit::TestCase
+
+  def setup
+    @fifo = FSFIFO.new
+
+    @of_proc_called = false
+    @uf_proc_called = false
+
+    @fifo.of_proc = Proc.new { p "of called."; @of_proc_called ^= true }
+    @fifo.uf_proc = Proc.new { p "uf called."; @uf_proc_called ^= true }
+  end
+
+  def teardown
+
+  end
+
+  ####
+  
+  def test_new
+
+    ff = FSFIFO.new( size: 10 )
+    assert_equal(  0, ff.size )
+    assert_equal( 10, ff.fifosize )
+
+  end
+
+  def test_size
+
+    assert_equal( 0, @fifo.size )
+    assert_equal( 1, @fifo.fifosize )
+
+  end
+
+  def test_resize
+
+    assert_equal( 0, @fifo.size )
+    assert_equal( 1, @fifo.fifosize )
+
+    #
+    @fifo.resize(10)
+    assert_equal(  0, @fifo.size )
+    assert_equal( 10, @fifo.fifosize )
+
+  end
+
+  ####
+  
+  def test_push_and_shift
+
+    #
+    assert_equal( 0, @fifo.size )
+    assert_equal( 1, @fifo.fifosize )
+
+    #
+    @fifo.push( 'a' )
+    assert_equal( 1, @fifo.size )
+    assert_equal( 1, @fifo.fifosize )
+    assert_equal( 'a', @fifo[0] )
+
+    ret = @fifo.shift
+    assert_equal( 0, @fifo.size )
+    assert_equal( 1, @fifo.fifosize )
+    assert_equal( [], @fifo )
+    assert_equal( 'a', ret )
+
+    @fifo.push( 'c' )
+    assert_equal( 1, @fifo.size )
+    assert_equal( 1, @fifo.fifosize )
+    assert_equal( 'c', @fifo[0] )
+
+  end
+
+  def test_resize_and_push
+
+    #
+    @fifo.resize( 4 )
+    assert_equal( 0, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+
+    #
+    ret = @fifo.push( 'm' )
+    assert_equal( 1, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+    assert_equal( 'm', ret.join )
+
+    @fifo.push( 'o' )
+    assert_equal( 2, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+    assert_equal( 'mo', @fifo.join )
+
+    @fifo.push( 'e' )
+    assert_equal( 3, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+    assert_equal( 'moe', @fifo.join )
+
+    @fifo.push( 'm' )
+    assert_equal( 4, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+    assert_equal( 'moem', @fifo.join )
+
+    @fifo.push( 'o' )
+    assert_equal( 4, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+    assert_equal( 'oemo', @fifo.join )
+
+    @fifo.push( 'e' )
+    assert_equal( 4, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+    assert_equal( 'emoe', @fifo.join )
+
+  end
+
+  def test_resize_push_and_resize
+
+    #
+    @fifo.resize( 4 )
+    assert_equal( 0, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+
+    #
+    "moemoe".split(/\B/).each do |e|
+      @fifo.push( e )
+    end
+    assert_equal( 4, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+    assert_equal( 'emoe', @fifo.join )
+
+    #
+    @fifo.resize(2)
+    assert_equal( 2, @fifo.size )
+    assert_equal( 2, @fifo.fifosize )
+    assert_equal( 'oe', @fifo.join )
+
+    #
+    @fifo.resize( 4 )
+    assert_equal( 2, @fifo.size )
+    assert_equal( 4, @fifo.fifosize )
+
+  end
+
+  ####
+  
+  def test_of
+
+    @fifo.of_enable
+    assert_equal( true, @fifo.of_enable? )
+
+    @fifo.push( 1 )
+    @fifo.push( 2 )
+    assert_equal( true, @of_proc_called )
+
+    @fifo.push( 3 )
+    assert_equal( false, @of_proc_called )
+
+    @fifo.of_disable
+    @fifo.push( 4 )
+    assert_equal( false, @of_proc_called )
+
+  end
+
+  def test_uf
+
+    @fifo.uf_enable
+    assert_equal( true, @fifo.uf_enable? )
+
+    @fifo.push( 1 )
+    @fifo.shift
+    assert_equal( true, @uf_proc_called )
+
+    @fifo.push( 2 )
+    @fifo.shift
+    assert_equal( false, @uf_proc_called )
+
+    @fifo.push( 3 )
+    @fifo.uf_disable
+    @fifo.shift
+    assert_equal( false, @uf_proc_called )
+
+  end
+
+
+end
+
+
+#### endof filename: test-fs_array.rb

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: fsfifo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- YAMAMOTO, Masayuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fixed size FIFO, LIFO, and Array.
+email: martin.route66.blues+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- ReadMe.md
+- VERSION
+- lib/fsfifo.rb
+- test/helper.rb
+- test/test_fsfifo.rb
+homepage: http://github.com/mephistobooks/fsfifo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Fixed size FIFO.
+test_files: []