typable_map 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typable_map.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+
+  # Rails 3.2
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/controllers/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+  
+  # Rails
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yusaku ONO
+
+MIT License
+
+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/README.md

@@ -0,0 +1,49 @@
+# TypableMap
+
+TypableMap assigns a uniq string to an object and fetches the object by the string.
+
+It's inspired by TweetIrcGateway and FacebookIrcGateway.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'typable_map'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typable_map
+
+## Usage
+
+    require 'typable_map'
+
+    typable_map = TypableMap::TypableMap.new(max_size: 1000, shuffle: true)
+
+    # assign a uniq string to an object
+
+    obj1 = Object.new
+    uniq_string1 = typable_map.push(obj1)
+    puts uniq_string1 # => 'vowi'
+
+    obj2 = Object.new
+    uniq_string2 = typable_map.push(obj2)
+    puts uniq_string2 # => 'lizo'
+
+    # fetch an object
+
+    obj1 = typable_map[uniq_string1]
+
+    obj2 = typable_map[uniq_string2]
+
+## 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

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake"
+require "rake/testtask"
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.libs.push 'spec'
+  t.libs.push 'lib'
+end

data/lib/typable_map.rb

@@ -0,0 +1,46 @@
+
+# https://github.com/shunirr/FacebookIrcGateway/blob/master/lib/facebook_irc_gateway/typable_map.rb
+
+require "typable_map/version"
+require "typable_map/counter"
+
+module TypableMap
+  class TypableMap < Hash
+    Roman = %w[
+a i u e o ka ki ku ke ko sa si su se so
+ta ti tu te to na ni nu ne no ha hi fu he ho
+ma mi mu me mo ya yu yo ra ri ru re ro
+wa wo
+ga gi gu ge go za ji zu ze zo da de do
+ba bi bu be bo pa pi pu pe po
+    ].freeze
+
+    def initialize(opts = {})
+      @seq = Roman.dup
+      @seq.shuffle! if opts.fetch(:shuffle, nil)
+      @seq.freeze
+      @counter = Counter.new(opts.fetch(:max_size, @seq.size))
+    end
+
+    def push(obj)
+      id = generate(@counter.next)
+      self[id] = obj
+      id
+    end
+    alias :<< :push
+
+    private 
+
+    def generate(n)
+      ret = []
+      begin
+        n, r = n.divmod(@seq.size)
+        ret << @seq[r]
+      end while n > 0
+      ret.reverse.join
+    end
+
+    :[]=
+    
+  end
+end

data/lib/typable_map/counter.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# -*- coding:utf-8 -*-
+
+module TypableMap
+  class Counter
+    def initialize(max_count = 100)
+      @n = 0
+      @max_count = max_count
+    end
+
+    def next
+      retval = @n
+      @n += 1
+      @n = @n % @max_count
+      retval
+    end
+  end
+end

data/lib/typable_map/version.rb

@@ -0,0 +1,3 @@
+module TypableMap
+  VERSION = "0.0.1"
+end

data/spec/counter_spec.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# -*- coding:utf-8 -*-
+
+require 'spec_helper'
+
+describe :Counter do
+  describe 'when use default args' do
+    it 'should return zero first' do
+      counter = TypableMap::Counter.new
+      counter.next.must_equal 0
+    end
+
+    it 'should return zero after count one hundred' do
+      counter = TypableMap::Counter.new
+      100.times do
+        counter.next
+      end
+      counter.next.must_equal 0
+    end
+  end
+
+  describe 'when use args' do
+    it 'should retern zero first' do
+      counter = TypableMap::Counter.new(3000)
+      counter.next.must_equal 0
+    end
+
+    it 'should retern zero after count args val' do
+      max_count = 3000
+      counter = TypableMap::Counter.new(max_count)
+      max_count.times do
+        counter.next
+      end
+      counter.next.must_equal 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# -*- coding:utf-8 -*-
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'minitest/unit'
+require 'minitest/autorun'
+
+require 'typable_map'
+require 'typable_map/counter'

data/spec/typable_map_spec.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+# -*- coding:utf-8 -*-
+
+require 'spec_helper'
+
+describe TypableMap do
+  before do
+    @typable_map = TypableMap::TypableMap.new(max_size: 1000, shuffle: true)
+  end
+
+  describe 'when use default args' do
+    it 'should initialize' do
+      typable_map = TypableMap::TypableMap.new
+      uniq_str = typable_map.push(Object.new)
+      uniq_str.wont_be_nil
+    end
+
+    it 'should generate string "a" first' do
+      typable_map = TypableMap::TypableMap.new
+      uniq_str = typable_map.push(Object.new)
+      uniq_str.must_equal "a"
+    end
+  end
+
+  describe 'when use max_size args' do
+    it 'should initialize' do
+      typable_map = TypableMap::TypableMap.new(max_size: 1000)
+      uniq_str = typable_map.push(Object.new)
+      uniq_str.wont_be_nil
+    end
+
+    it 'should generate string "a" first' do
+      typable_map = TypableMap::TypableMap.new
+      uniq_str = typable_map.push(Object.new)
+      uniq_str.must_equal "a"
+    end
+  end
+
+  describe 'when use shuffle args' do
+    it 'should initialize' do
+      typable_map = TypableMap::TypableMap.new(shuffle: true)
+      uniq_str = typable_map.push(Object.new)
+      uniq_str.wont_be_nil
+    end
+  end
+
+  describe 'when push object' do
+    it 'should generate uniq string' do
+      inserted_obj = Object.new
+      uniq_str = @typable_map.push(inserted_obj)
+      uniq_str.wont_equal "aaaa"
+    end
+  end
+
+  describe 'when pull object' do
+    it 'should retern the object' do
+      inserted_obj = Object.new
+      uniq_str = @typable_map.push(inserted_obj)
+
+      fetched_obj = @typable_map[uniq_str]
+      fetched_obj.must_equal inserted_obj
+    end
+  end
+
+  describe 'when push a object many times' do
+    it 'should generate uniq strings' do
+      before_str = ''
+      1000.times do
+        inserted_obj = Object.new
+        uniq_str = @typable_map.push(inserted_obj)
+        uniq_str.wont_equal before_str
+        before_str = uniq_str
+      end
+    end
+  end
+end

data/typable_map.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typable_map/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "typable_map"
+  gem.version       = TypableMap::VERSION
+  gem.authors       = ["Yusaku ONO"]
+  gem.email         = ["yono.05@gmail.com"]
+  gem.description   = %q{TypableMap library inspired by TweetIrcGateway and FacebookIrcGateway}
+  gem.summary       = %q{TypableMap library inspired by TweetIrcGateway and FacebookIrcGateway}
+  gem.homepage      = ""
+
+  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"]
+
+  gem.add_development_dependency 'guard-minitest'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: typable_map
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yusaku ONO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  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: TypableMap library inspired by TweetIrcGateway and FacebookIrcGateway
+email:
+- yono.05@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/typable_map.rb
+- lib/typable_map/counter.rb
+- lib/typable_map/version.rb
+- spec/counter_spec.rb
+- spec/spec_helper.rb
+- spec/typable_map_spec.rb
+- typable_map.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: TypableMap library inspired by TweetIrcGateway and FacebookIrcGateway
+test_files:
+- spec/counter_spec.rb
+- spec/spec_helper.rb
+- spec/typable_map_spec.rb