elasticsearch-extensions 0.0.2 → 0.0.3

data/README.md

@@ -5,6 +5,22 @@ This library provides a set of extensions to the
 
 ## Extensions
 
+### ANSI
+
+Colorize and format selected  Elasticsearch response parts in terminal:
+
+Display formatted search results:
+
+    require 'elasticsearch/extensions/ansi'
+    puts Elasticsearch::Client.new.search.to_ansi
+
+Display a table with the output of the `_analyze` API:
+
+    require 'elasticsearch/extensions/ansi'
+    puts Elasticsearch::Client.new.indices.analyze(text: 'Quick Brown Fox Jumped').to_ansi
+
+[Full documentation](http://rubydoc.info/gems/elasticsearch-extensions/Elasticsearch/Extensions/ANSI).
+
 ## Installation
 
 Install the package from [Rubygems](https://rubygems.org):

data/Rakefile

@@ -8,7 +8,19 @@ task :test    => 'test:unit'
 
 require 'rake/testtask'
 namespace :test do
+  task :ci_reporter do
+    ENV['CI_REPORTS'] ||= 'tmp/reports'
+    if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
+      require 'ci/reporter/rake/test_unit'
+      Rake::Task['ci:setup:testunit'].invoke
+    else
+      require 'ci/reporter/rake/minitest'
+      Rake::Task['ci:setup:minitest'].invoke
+    end
+  end
+
   Rake::TestTask.new(:unit) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/unit/**/*_test.rb"]
     # test.verbose = true
@@ -16,16 +28,19 @@ namespace :test do
   end
 
   Rake::TestTask.new(:integration) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/integration/**/*_test.rb"]
   end
 
   Rake::TestTask.new(:all) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
   end
 
   Rake::TestTask.new(:profile) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/profile/**/*_test.rb"]
   end

data/elasticsearch-extensions.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency "elasticsearch", '0.4.0'
+  s.add_dependency "elasticsearch", '~> 0.4.0'
   s.add_dependency "ansi"
 
 
@@ -30,10 +30,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency "turn"
   s.add_development_dependency "yard"
   s.add_development_dependency "ruby-prof"
+  s.add_development_dependency "ci_reporter"
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
     s.add_development_dependency "simplecov"
     s.add_development_dependency "cane"
     s.add_development_dependency "require-prof"
+    s.add_development_dependency "coveralls"
   end
 end

data/lib/elasticsearch/extensions/ansi.rb

@@ -15,7 +15,22 @@ require 'elasticsearch/extensions/ansi/response'
 
 module Elasticsearch
   module Extensions
+
+    # This extension provides a {ResponseBody#to_ansi} method for the Elasticsearch response body,
+    # which colorizes and formats the output with the `ansi` gem.
+    #
+    # @example Display formatted search results
+    #
+    #     require 'elasticsearch/extensions/ansi'
+    #     puts Elasticsearch::Client.new.search.to_ansi
+    #
+    # @example Display a table with the output of the `_analyze` API
+    #
+    #     require 'elasticsearch/extensions/ansi'
+    #     puts Elasticsearch::Client.new.indices.analyze(text: 'Quick Brown Fox Jumped').to_ansi
+    #
     module ANSI
     end
+
   end
 end

data/lib/elasticsearch/extensions/ansi/response.rb

@@ -10,7 +10,19 @@ module Elasticsearch
         end
 
         # Return a [colorized and formatted](http://en.wikipedia.org/wiki/ANSI_escape_code)
-        # representation of the Elasticsearch response body
+        # representation of the Elasticsearch response for:
+        #
+        # * Search results (hits and highlights)
+        # * Facets (terms, statistical, date_histogram)
+        # * Analyze API output
+        # * Shard allocation
+        #
+        # @example Display formatted search results
+        #
+        #     require 'elasticsearch/extensions/ansi'
+        #     puts Elasticsearch::Client.new.search.to_ansi
+        #
+        # @todo Add all facets and handlers for remaining response parts / types
         #
         def to_ansi(options={})
           output = Actions.public_methods.select do |m|

data/lib/elasticsearch/extensions/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Extensions
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
@@ -155,6 +155,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +219,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Extensions for the Elasticsearch Rubygem
 email:
 - karel.minarik@elasticsearch.org