Module: WhatIMean

Defined in:
lib/whatimean.rb,
lib/whatimean/find.rb,
lib/whatimean/word.rb,
lib/whatimean/google.rb,
lib/whatimean/version.rb

Defined Under Namespace

Classes: Configuration, Find, Google, Word

Constant Summary collapse

VERSION =

WhatIMean Version bumper

"0.2.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



8
9
10
 
# File 'lib/whatimean.rb', line 8

def configuration
  @configuration
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Call this method to modify defaults in your initializers.

Examples:

WhatIMean.configure do |config|
  config.api_key = 'MY_API_KEY'
end

Yields:



17
18
19
20
 
# File 'lib/whatimean.rb', line 17

def self.configure
  self.configuration ||= Configuration.new
  yield(configuration)
end

.is(*words) ⇒ Array<Word>

Compare strings and return a list ordered by occurence

Parameters:

  • words (Array<String>) —

    The words to be compared

Returns:

  • (Array<Word>) —

    the words with hits counter and comparison rates



37
38
39
 
# File 'lib/whatimean.rb', line 37

def self.is(*words)
  Find.new(client, *words)
end