Module: JLPT

Defined in:
lib/jlpt.rb,
lib/jlpt/cli.rb,
lib/jlpt/version.rb,
lib/jlpt/core/kanji.rb,
lib/jlpt/core/config.rb,
lib/jlpt/core/engine.rb,
lib/jlpt/core/analyzer.rb,
lib/jlpt/core/tokenizer.rb,
lib/jlpt/core/dictionary.rb,
lib/jlpt/analyzers/dokkai.rb,
lib/jlpt/analyzers/jukugo.rb,
lib/jlpt/analyzers/syntax.rb,
lib/jlpt/analyzers/grammar.rb,
lib/jlpt/core/preprocessor.rb,
lib/jlpt/analyzers/comparer.rb,
lib/jlpt/core/cache_manager.rb,
lib/jlpt/core/kanji_details.rb,
lib/jlpt/analyzers/loanwords.rb,
lib/jlpt/formatters/exporter.rb,
lib/jlpt/formatters/furigana.rb,
lib/jlpt/formatters/reporter.rb,
lib/jlpt/analyzers/simplifier.rb,
lib/jlpt/core/analysis_result.rb,
lib/jlpt/analyzers/conjugation.rb,
lib/jlpt/analyzers/onomatopeia.rb,
lib/jlpt/core/vocab_classifier.rb,
lib/jlpt/active_model/validator.rb,
lib/jlpt/analyzers/corpus_stats.rb,
lib/jlpt/analyzers/pitch_accent.rb,
lib/jlpt/analyzers/pos_profiler.rb,
lib/jlpt/analyzers/exam_readiness.rb,
lib/jlpt/analyzers/style_profiler.rb,
lib/jlpt/formatters/batch_processor.rb

Overview

Main entry point for the JLPT Japanese text analysis library.

Defined Under Namespace

Modules: ActiveModel, Analyzer, BatchProcessor, CLI, CacheManager, Comparer, Conjugation, CorpusStats, Dictionary, Dokkai, Engine, ExamReadiness, Exporter, Furigana, Grammar, Jukugo, Kanji, KanjiDetails, Loanwords, Onomatopeia, PitchAccent, PosProfiler, Preprocessor, Reporter, Simplifier, StyleProfiler, Syntax, Tokenizer, VocabClassifier Classes: AnalysisResult, Config, Error

Constant Summary collapse

VERSION = 
'1.1.0'

Class Method Summary collapse

Class Method Details

.analyze(text) ⇒ JLPT::AnalysisResult

Analyze Japanese text and return difficulty metrics & JLPT recommendation

Parameters:

  • text (String) —

    Japanese text

Returns:



46
47
48
 
# File 'lib/jlpt.rb', line 46

def analyze(text)
  Analyzer.analyze(text)
end

.config ⇒ JLPT::Config

Return global config instance

Returns:



29
30
31
 
# File 'lib/jlpt/core/config.rb', line 29

def config
  @config ||= Config.new
end

.configure {|JLPT::Config| ... } ⇒ Object

Configure global JLPT library settings

Yields:



36
37
38
 
# File 'lib/jlpt/core/config.rb', line 36

def configure
  yield(config) if block_given?
end

.reset_config! ⇒ Object

Reset configuration to defaults



41
42
43
 
# File 'lib/jlpt/core/config.rb', line 41

def reset_config!
  config.reset!
end