datamuse_rb 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae56ca25f841eaff18296862d348b30a4325b3a16d7a466f370ffc9be6c220de
-  data.tar.gz: d74cfee5328f859cc5930c3d6b8732f943e429f4599515a6e15f4316a028ca74
+  metadata.gz: aa7c26ce44a5909155c4024167e1b0f43cda45951845094737555f464b16cdb1
+  data.tar.gz: ac429da7e7a807b15cd52bc274e1b1cb203eb6a8c42ebba1f1cf1ee3e45766f2
 SHA512:
-  metadata.gz: 80d518dd0aa2bf1b29dbdbbb5def839cf8401b976fef6269de2620420341509e2919297ad845695914f278bf3bb377cc21ec81e56b0955b4d28fa39e399f6c81
-  data.tar.gz: a3e2b7c5838efb034d3cfb54304ae2ed3b303fb02702da22a1c395708574b1360326687b12f8d51dbc3882d8717087ccd1ed2726c1a88ab3e0f3cc3f174e01b7
+  metadata.gz: b5eeab797fb410203a1c01cae3534f3f255c170a04d48782808af6f8cdf4445ccedfe66171fdebb7035598427f5df348c14af43566f5f37180f4e4bf1568a37b
+  data.tar.gz: 26cb4dcb3a93ce93069c47a2bf7ce116b26e94624b86e91a7e6db2e1f162251ba198a7962aa3dca5823e2907ffd05c44d89a48c39738040481a5147ca2f596a1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    datamuse_rb (0.1.0)
+    datamuse_rb (0.1.2)
       coveralls
       httparty
 
@@ -16,9 +16,13 @@ GEM
       tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.3.1)
-    httparty (0.16.2)
+    httparty (0.17.0)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    json (2.1.0)
+    json (2.2.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
     multi_xml (0.6.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -54,4 +58,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.4
+   1.17.3

data/README.md

@@ -1,13 +1,17 @@
 [![Build Status](https://travis-ci.org/bynarlogic/datamuse-rb.svg?branch=master)](https://travis-ci.org/bynarlogic/datamuse-rb)
+[![Gem Version](https://badge.fury.io/rb/datamuse_rb.svg)](https://badge.fury.io/rb/datamuse_rb)
 [![Coverage Status](https://coveralls.io/repos/github/bynarlogic/datamuse-rb/badge.svg?branch=master)](https://coveralls.io/github/bynarlogic/datamuse-rb?branch=master)
 
 # DatamuseRb
 
+**Deprecation Warning:** DatamuseRB will no longer extend the String class directly. String will only be extended within classes or modules using DatamuseRB starting in version 0.2.0. See the updated examples below. 
+
 DatamuseRb is yet another Ruby wrapper for the wonderful [Datamuse API](https://www.datamuse.com/api/). The approach for this gem is a little different. DatamuseRb extends the Ruby String Class with Datamuse methods. Methods can be chained much like the actual Datamuse API allows.
 
 Example: Words related to duck that start with the letter b
 
 ```ruby
+using DatamuseRB
 "duck".means_like.spelled_like("b*")
 ```
 
@@ -34,6 +38,7 @@ DatamuseRB currently supports all of the /words functions. Please visit the [dat
 Basic Usage:
 
 ```ruby
+using DatamuseRB
 #Call on any string
 "ruby".means_like
  => #<DatamuseRB::DatamuseResult word="red", score=84986, tags=["syn", "n", "adj"]>

data/lib/datamuse_rb.rb

@@ -10,28 +10,41 @@ module DatamuseRB
 
     def self.send(endpoint,**queries)
       response = get(endpoint,query: queries)
-      DatamuseResultList.new(response.parsed_response,queries)
+      DatamuseResults.new(response.parsed_response,queries)
     end
   end
 
-  class DatamuseResultList
-    extend Forwardable
-    attr_accessor :results
-    delegate [:first, :each] => :@results
+  class DatamuseResult < OpenStruct
+  end
+
+  class DatamuseResults
+    include Enumerable
 
-    def initialize(response,query)
+    def initialize(response, query)
       @results = response.map {|r| DatamuseResult.new(r)}
       @query = query
     end
 
+    def each(&block)
+      @results.each do |result|
+        block.call(result)
+      end
+    end
+
+    def empty?
+      none?
+    end
+
+    private
+
     def method_missing(name,*args)
-      super unless WORD_METHODS[name] && args.first
+      super unless WORD_METHODS[name] && args.any?
       @query.merge! WORD_METHODS[name] => args.first
       DatamuseRequest.send("/words",@query)
     end
-  end
 
-  class DatamuseResult < OpenStruct
+    attr_reader :results, :query
+
   end
 
   WORD_METHODS = {
@@ -43,15 +56,34 @@ module DatamuseRB
     related_homophones: :rel_hom,consonant_match: :rel_cns
   }
 
+  refine String do
+    WORD_METHODS.each do |k,v|
+      define_method(k) do
+        DatamuseRequest.send("/words",v => self)
+      end
+    end
+  end
+
+  def warning_message
+    <<~HEREDOC
+      DatamuseRB Deprecation Notice: 
+      String will no longer be globally extended starting in version 0.2.0.
+      Add 'using DatamuseRB' to the module or class that uses this behavior. 
+      For further details visit https://github.com/bynarlogic/datamuse-rb
+    HEREDOC
+  end
+
 end
 
 class String
   include DatamuseRB
-
   WORD_METHODS.each do |k,v|
     define_method(k) do
+      warn(warning_message)
       DatamuseRequest.send("/words",v => self)
     end
   end
-
 end
+
+
+

data/lib/datamuse_rb/version.rb

@@ -1,3 +1,3 @@
 module DatamuseRB
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datamuse_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Joshua D Jarvis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2019-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler