ngrams-enabler 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjEyNjc3YTM2MTA4YmVjMjQ3OGNiMzM1NmRjNzI5YWFmYTE0YWVlNQ==
+  data.tar.gz: !binary |-
+    ODYwYTMyNTNkZWJjNDI5NTQzMDZkYmYzNTM2ZDdlYWE0ZWFlNzhjMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTkzNmYxYTYxZjUzNmQ3ODViNzEzMzRlN2NhZDIyMzQ4NGNjY2VlZmZhYTQw
+    YjQ1NzcyZWNiMTBhZTMyMTZjNmY4ZWYxMWUzZTVhZWZjOWU1OGM2YWYwYmMz
+    ZWJjYmMwMWE5MTcwODI1NjFkMDA1YmE5OWNlY2VjYjJiMDMwMGI=
+  data.tar.gz: !binary |-
+    YjBmODI1YjkxYjk2ZTE2ZTNkZWJjZmUyMzM4NWMwYjE2NDFjMDU2ODVlYThh
+    YzQ4MjcyMGExZDVjMzNhNTc5NjYyNTkxNjhhZDJlMzMyZWFjYzg2OTdhYjdk
+    NGY3ODkyZGJlMzAzM2RiNTY2OTc2MzU5YjFjYzg3Yjg3OTQ4MzY=

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - jruby-19mode
+  - rbx-19mode
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,41 @@
+ngrams-enabler [![Build Status](https://travis-ci.org/lloydmeta/ngrams-enabler.png?branch=master)](https://travis-ci.org/lloydmeta/ngrams-enabler) [![Code Climate](https://codeclimate.com/github/lloydmeta/ngrams-enabler.png)](https://codeclimate.com/github/lloydmeta/ngrams-enabler)
+-------------
+
+A simple way of getting ngrams out of any given String object. Supports CJK (Chinese, Japanese, Korean) as well as alphabet based languages.
+
+Example Usage
+=========
+
+```ruby
+require 'ngrams_enabler'
+
+"This is just a test".ngrams
+
+"This is just a test".ngrams(2)
+
+"こんにちは".ngrams
+
+"こんにちは".ngrams(2)
+```
+
+## License
+
+Copyright (c) 2013 by Lloyd Chan
+
+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, 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,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+end
+
+task :default  => :spec

data/lib/ngrams/core_extensions/string.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+class String
+
+  def ngrams(n = 1, options = {})
+    split_char = options.fetch(:split_char, ' ')
+    is_cjk_string = contains_cjk?
+    tokens = is_cjk_string ? self.split(//u) : self.split(split_char)
+    if tokens.size <= n
+      self
+    else
+      is_cjk_string ? tokens.each_cons(n).map(&:join) : tokens.each_cons(n).map{|cons| cons.join(split_char)}
+    end
+  end
+
+  private
+
+    def contains_cjk?
+      !!(self =~ /\p{Han}|\p{Katakana}|\p{Hiragana}|\p{Hangul}/)
+    end
+
+end

data/lib/ngrams_enabler.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'ngrams/core_extensions/string'

data/ngrams-enabler.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |gem|
+    gem.name        = %q{ngrams-enabler}
+    gem.version = "0.0.1"
+    gem.date = %q{2013-05-16}
+    gem.authors     = ["Lloyd Meta"]
+    gem.email       = ["lloydmeta@gmail.com"]
+    gem.homepage    = "http://github.com/lloydmeta/ngrams-enabler"
+    gem.description = %q{A simple way of getting ngrams out of any given String object. Supports CJK (Chinese, Japanese, Korean) as well as alphabet based languages.}
+    gem.summary     = gem.description
+
+    gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+    gem.files         = `git ls-files`.split("\n")
+    gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+    gem.require_paths = ["lib"]
+
+    gem.add_development_dependency 'rake'
+    gem.add_development_dependency 'rspec'
+end

data/spec/ngrams_enabler/ngrams_enabler_spec.rb

@@ -0,0 +1,39 @@
+#encoding: UTF-8
+require 'spec_helper'
+
+describe String do
+
+  let(:cjk_string){"これは日本語"}
+  let(:english_string){"this string is in english"}
+
+  describe "#ngrams" do
+
+    context "not CJK" do
+
+      it "should return the proper default ngrams" do
+        ngrams = english_string.ngrams
+        ngrams.should eq(english_string.split(" "))
+      end
+
+      it "should allow me to set higher n" do
+        english_string.ngrams(2).should eq(['this string', 'string is', 'is in', 'in english'])
+      end
+
+    end
+
+    context "CJK string" do
+
+      it "should return the proper default ngrams" do
+        ngrams = cjk_string.ngrams
+        ngrams.should eq(%w[こ れ は 日 本 語])
+      end
+
+      it "should allow me to set higher n" do
+        cjk_string.ngrams(2).should eq(%w[これ れは は日 日本 本語])
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'rspec'
+require 'rspec/mocks'
+require 'ngrams_enabler'
+
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+
+  #nothing yet
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ngrams-enabler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lloyd Meta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: A simple way of getting ngrams out of any given String object. Supports
+  CJK (Chinese, Japanese, Korean) as well as alphabet based languages.
+email:
+- lloydmeta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/ngrams/core_extensions/string.rb
+- lib/ngrams_enabler.rb
+- ngrams-enabler.gemspec
+- spec/ngrams_enabler/ngrams_enabler_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/lloydmeta/ngrams-enabler
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: A simple way of getting ngrams out of any given String object. Supports CJK
+  (Chinese, Japanese, Korean) as well as alphabet based languages.
+test_files:
+- spec/ngrams_enabler/ngrams_enabler_spec.rb
+- spec/spec_helper.rb