that_language 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55ee472553f58911e2ae6ce8dcc5bb3810a2d5ad
-  data.tar.gz: 90319b193692262d7cc03da0303361b87fc9b5ef
+  metadata.gz: 41ecd55149abde5d1b27e64be73afd2e63d0b821
+  data.tar.gz: 82764566978fa2fdee98eaf3f8d7f7b71bdb6742
 SHA512:
-  metadata.gz: aa3e9829509503cf095fbcda14533402c02116d2bb0174f6c792475269ce335dd440f1d096fa1060633f9c183d43d712b3ea6979b616ac089829ad965a47c071
-  data.tar.gz: 5815e76c184809b88d85e965f01108b52affe623fb0fd0afc97ec33d4d29d2b1c214bb19e552fece2c34e3d4c0e21b498fe8834c254d2eac32fd78129297629f
+  metadata.gz: f4c718d69f9f1f38da49d24f80d01507064aa32a6571bfbe31ac99f2ac5ce45fdbd2437c2a9599cb1be6d9f36ae4838ec1783491826e1bd4642b714f9c5e83f3
+  data.tar.gz: 8d1482da930ffe300f288476b11274f22b001df698f49d7901fdfbb6944b827b75f37a0f3650892ce3433932fb843dd918c5425a3b285cbd7c99a95229624233

data/README.md

@@ -1,15 +1,11 @@
-# DetectLanguage
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/detect_language`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# ThatLanguage
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'detect_language'
+gem 'that_language'
 ```
 
 And then execute:
@@ -18,32 +14,199 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install detect_language
+    $ gem install that_language
+
+## Examples
+
+```ruby
+text = "This is just a random english sentence."
+
+## == Language
+
+  ThatLanguage.language(text)
+  # => :English
+
+
+## == LanguageCode
+
+  ThatLanguage.language_code(text)
+  # => "en"
+
+
+## == Detect
+
+  detect = ThatLanguage.detect(text)
+  # => #<ThatLanguage::Result:...
+
+  detect.language
+  # => :English
+
+  detect.language_code
+  # => "en"
+
+  detect.confidence
+  # => 0.5631093821386951
+
+  detect.to_h
+  # =>
+  # {
+  #   language: :English,
+  #   language_code: "en",
+  #   confidence: 0.5631093821386951,
+  #   value: 3.9417656749708656,
+  #   hit_ratio: 0.8571428571428571,
+  #   hit_count: 6,
+  #   words_count: 7
+  # }
+
+
+## == Details
+
+  details = ThatLanguage.details(text)
+  # => #<ThatLanguage::ResultSet:...
+
+  winner = details.winner
+  # => #<ThatLanguage::Result:...
+
+  results = details.results
+  # => [#<ThatLanguage::Result, #<ThatLanguage::Result, ...]
+
+  details.to_h
+  # =>
+  # {
+  #   "results" => [
+  #     {
+  #       language: :English,
+  #       language_code: "en",
+  #       confidence: 0.5631093821386951,
+  #       value: 3.9417656749708656,
+  #       hit_ratio: 0.8571428571428571,
+  #       hit_count: 6,
+  #       words_count: 7
+  #     },
+  #     {
+  #       language: :Hungarian,
+  #       language_code: "hu",
+  #       confidence: 0.21380816083786156,
+  #       value: 1.496657125865031,
+  #       hit_ratio: 0.42857142857142855,
+  #       hit_count: 3,
+  #       words_count: 7
+  #     },
+  #     # ...
+  #   ]
+  # }
+```
 
 ## Supported locales
 
-* ar
-* da
-* de
-* en
-* es
-* fa
-* fr
-* it
-* nl
-* pt
-* ru
-* sv
+```ruby
+require 'pp'
+
+pp ThatLanguage.available
+
+{
+  ak: :Akan,
+  am: :Amharic,
+  ar: :Arabic,
+  as: :Assamese,
+  az: :Azerbaijani,
+  be: :Belarusian,
+  bn: :Bengali,
+  cs: :Czech,
+  da: :Danish,
+  de: :German,
+  el: :Greek,
+  en: :English,
+  es: :Spanish,
+  fa: :Persian,
+  ff: :Fula,
+  fi: :Finnish,
+  fr: :French,
+  gu: :Gujarati,
+  ha: :Hausa,
+  he: :Hebrew,
+  hi: :Hindi,
+  ht: :Haitian,
+  hu: :Hungarian,
+  it: :Italian,
+  ja: :Japanese,
+  jv: :Javanese,
+  kk: :Kazakh,
+  km: :Khmer,
+  kn: :Kannada,
+  ko: :Korean,
+  ku: :Kurdish,
+  mg: :Malagasy,
+  mr: :Marathi,
+  ms: :Malay,
+  my: :Burmese,
+  ne: :Nepali,
+  nl: :Dutch,
+  nn: :"Norwegian Nynorsk",
+  no: :Norwegian,
+  ny: :Chichewa,
+  om: :Oromo,
+  or: :Oriya,
+  pa: :Panjabi,
+  pl: :Polish,
+  ps: :Pashto,
+  pt: :Portuguese,
+  qu: :Quechua,
+  rn: :Kirundi,
+  ro: :Romanian,
+  ru: :Russian,
+  rw: :Kinyarwanda,
+  sd: :Sindhi,
+  si: :Sinhala,
+  sn: :Shona,
+  so: :Somali,
+  su: :Sundanese,
+  sv: :Swedish,
+  ta: :Tamil,
+  te: :Telugu,
+  th: :Thai,
+  tk: :Turkmen,
+  tl: :Tagalog,
+  tr: :Turkish,
+  ug: :Uyghur,
+  uk: :Ukrainian,
+  ur: :Urdu,
+  uz: :Uzbek,
+  vi: :Vietnamese,
+  xh: :Xhosa,
+  yo: :Yoruba,
+  zh: :Chinese,
+  zu: :Zulu
+}
+
+```
+
+## Configure
+
+To use a custom directory that contains all the wordlists:
+
+```ruby
+ThatLanguage.configure do |config|
+  config.wordlist_path = File.join("wordlists", "100k")
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/detect_language. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Deradon/that_language.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "detect_language"
+require "that_language"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/that_language.rb

@@ -15,6 +15,10 @@ module ThatLanguage
     end
     alias_method :config, :configuration
 
+    def configure
+      yield(config)
+    end
+
     def language(text)
       detect_context.language(text)
     end

data/lib/that_language/configuration.rb

@@ -1,11 +1,13 @@
 module ThatLanguage
   class Configuration
-    attr_reader :wordlist_path
-
-    def initialize
-      @wordlist_path = File.absolute_path(
+    def wordlist_path
+      @wordlist_path ||= File.absolute_path(
         File.join(File.dirname(__FILE__), '../../wordlists/10k/')
       )
     end
+
+    def wordlist_path=(path)
+      @wordlist_path = path
+    end
   end
 end

data/lib/that_language/result.rb

@@ -43,9 +43,13 @@ module ThatLanguage
       value > other.value
     end
 
+    def language
+      Iso639[language_code]
+    end
+
     def to_h
       {
-        language: Iso639[language_code],
+        language: language,
         language_code: language_code,
         confidence: confidence,
         value: value,

data/lib/that_language/version.rb

@@ -1,3 +1,3 @@
 module ThatLanguage
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/that_language.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["me@patrick-helm.de"]
 
   spec.summary       = %q{Detect language of given text}
-  spec.description   = %q{Detect language of given text}
-  spec.homepage      = "http://gitlab.patrick-helm.de/Ruby/that-language"
+  # spec.description   = %q{Detect language of given text}
+  spec.homepage      = "https://github.com/Deradon/that_language"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: that_language
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Patrick Helm
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Detect language of given text
+description: 
 email:
 - me@patrick-helm.de
 executables: []
@@ -166,7 +180,7 @@ files:
 - wordlists/10k/10000-yo.pstore
 - wordlists/10k/10000-zh.pstore
 - wordlists/10k/10000-zu.pstore
-homepage: http://gitlab.patrick-helm.de/Ruby/that-language
+homepage: https://github.com/Deradon/that_language
 licenses:
 - MIT
 metadata: {}