style fixes, added deprecation warning on sendMSg

Author: joekiller

CHANGELOG

@@ -1,3 +1,9 @@
+0.2.1 (September 22, 2014)
+    # producer
+    - fixed argument parser including nil options
+    - updated compressed.topics to take an array and transform it into comma separated list.
+    - removed compressed.topics parsing log fallacy.
+    - tons of inspection/style fixes
 0.2.0 (September 20, 2014)
     # producer
     - exposed close method to producer for cleanup in async threads.

README.md

@@ -11,7 +11,7 @@
 
 ## About
 
-This gem is primarily used to wrap most of the [Kafka 0.8.0 high level consumer] and [Kafka 0.8.0 producer] API into
+This gem is primarily used to wrap most of the [Kafka 0.8.1.1 high level consumer] and [Kafka 0.8.1.1 producer] API into
 jruby.
 The [Kafka Consumer Group Example] is pretty much ported to this library.
 
@@ -21,7 +21,7 @@ The [Kafka Consumer Group Example] is pretty much ported to this library.
 
 ## Installation
 
-This package is now distruted via rubygems.org but you can build it using the following instructions.
+This package is now distributed via [RubyGems.org](http://rubygems.org) but you can build it using the following instructions.
 
 From the root of the project run:
 
@@ -57,7 +57,7 @@ make a producer
     producer_options = {:topic_id => "test", :broker_list => "localhost:9092"}
     producer = Kafka::Producer.new(producer_options)
     producer.connect()
-    producer.sendMsg(nil, "heres a test")
+    producer.sendMsg(nil, "here's a test")
 
 
 then a consumer

Rakefile

@@ -1,20 +1,20 @@
 task :package do
-  system("gem build jruby-kafka.gemspec")
+  system('gem build jruby-kafka.gemspec')
 end
 
 task :publish do
-  Rake::Task["clean"].execute
-  Rake::Task["package"].execute
-  system("gem push jruby-kafka*.gem")
+  Rake::Task['clean'].execute
+  Rake::Task['package'].execute
+  system('gem push jruby-kafka*.gem')
 end
 
 
 task :install do
-  Rake::Task["package"].execute
-  system("gem install jruby-kafka*.gem")
-  Rake::Task["clean"].execute
+  Rake::Task['package'].execute
+  system('gem install jruby-kafka*.gem')
+  Rake::Task['clean'].execute
 end
 
 task :clean do
-  system("rm jruby*.gem")
+  system('rm jruby*.gem')
 end

jruby-kafka.gemspec

@@ -5,18 +5,18 @@ Gem::Specification.new do |spec|
     files += Dir["#{dir}/**/*"]
   end
 
-  spec.name          = "jruby-kafka"
-  spec.version       = "0.2.0"
-  spec.authors       = ["Joseph Lawson"]
-  spec.email         = ["[email protected]"]
-  spec.description   = "this is primarily to be used as an interface for logstash"
-  spec.summary       = "jruby Kafka wrapper"
-  spec.homepage      = "https://github.com/joekiller/jruby-kafka"
-  spec.license       = "Apache 2.0"
-  spec.platform      = "java"
+  spec.name          = 'jruby-kafka'
+  spec.version       = '0.2.0'
+  spec.authors       = ['Joseph Lawson']
+  spec.email         = ['[email protected]']
+  spec.description   = 'this is primarily to be used as an interface for logstash'
+  spec.summary       = 'jruby Kafka wrapper'
+  spec.homepage      = 'https://github.com/joekiller/jruby-kafka'
+  spec.license       = 'Apache 2.0'
+  spec.platform      = 'java'
 
   spec.files         = files
-  spec.require_paths << "lib"
+  spec.require_paths << 'lib'
 
   spec.add_dependency 'jbundler', '0.5.5'
   spec.requirements << "jar 'org.apache.kafka:kafka_2.9.2', '0.8.1.1'"

lib/jruby-kafka.rb

@@ -7,12 +7,12 @@
 #
 if not defined? JBUNDLER_CLASSPATH and ENV['KAFKA_PATH']
   require 'jruby-kafka/loader'
-  Kafka.load_jars()
+  Kafka.load_jars
 end
 
-require "jruby-kafka/consumer"
-require "jruby-kafka/group"
-require "jruby-kafka/producer"
+require 'jruby-kafka/consumer'
+require 'jruby-kafka/group'
+require 'jruby-kafka/producer'
 
 module Kafka
 end

lib/jruby-kafka/consumer.rb

@@ -1,33 +1,34 @@
-require "java"
-require "jruby-kafka/namespace"
-
-java_import 'kafka.consumer.ConsumerIterator'
-java_import 'kafka.consumer.KafkaStream'
-java_import 'kafka.common.ConsumerRebalanceFailedException'
-java_import 'kafka.consumer.ConsumerTimeoutException'
+require 'java'
+require 'jruby-kafka/namespace'
 
+# noinspection JRubyStringImportInspection
 class Kafka::Consumer
+  java_import 'kafka.consumer.ConsumerIterator'
+  java_import 'kafka.consumer.KafkaStream'
+  java_import 'kafka.common.ConsumerRebalanceFailedException'
+  java_import 'kafka.consumer.ConsumerTimeoutException'
+
   include Java::JavaLang::Runnable
   java_signature 'void run()'
 
   @m_stream
-  @m_threadNumber
+  @m_thread_number
   @m_queue
 
-    def initialize(a_stream, a_threadNumber, a_queue, a_bool_restart_on_exception, a_sleep_ms)
-      @m_threadNumber = a_threadNumber
+    def initialize(a_stream, a_thread_number, a_queue, restart_on_exception, a_sleep_ms)
+      @m_thread_number = a_thread_number
       @m_stream = a_stream
       @m_queue = a_queue
-      @m_restart_on_exception = a_bool_restart_on_exception
+      @m_restart_on_exception = restart_on_exception
       @m_sleep_ms = 1.0 / 1000.0 * Float(a_sleep_ms)
     end
 
     def run
-      it = @m_stream.iterator()
+      it = @m_stream.iterator
       begin
-        while it.hasNext()
+        while it.hasNext
           begin
-            @m_queue << it.next().message()
+            @m_queue << it.next.message
           end
         end
       rescue Exception => e

lib/jruby-kafka/error.rb

@@ -1,4 +1,4 @@
-require "jruby-kafka/namespace"
+require 'jruby-kafka/namespace'
 
 class KafkaError < StandardError
   attr_reader :object

lib/jruby-kafka/group.rb

@@ -1,16 +1,17 @@
 # basically we are porting this https://cwiki.apache.org/confluence/display/KAFKA/Consumer+Group+Example
 
-require "java"
+require 'java'
 
-require "jruby-kafka/namespace"
-require "jruby-kafka/consumer"
-require "jruby-kafka/error"
-
-java_import 'java.util.concurrent.ExecutorService'
-java_import 'java.util.concurrent.Executors'
-java_import 'org.I0Itec.zkclient.exception.ZkException'
+require 'jruby-kafka/namespace'
+require 'jruby-kafka/consumer'
+require 'jruby-kafka/error'
 
+# noinspection JRubyStringImportInspection
 class Kafka::Group
+  java_import 'java.util.concurrent.ExecutorService'
+  java_import 'java.util.concurrent.Executors'
+  java_import 'org.I0Itec.zkclient.exception.ZkException'
+
   @consumer
   @executor
   @topic
@@ -136,81 +137,80 @@ def initialize(options={})
     end
   end
 
-  private
-  def validate_required_arguments(options={})
-    [:zk_connect, :group_id, :topic_id].each do |opt|
-      raise(ArgumentError, "#{opt} is required.") unless options[opt]
-    end
-  end
-
   public
-  def shutdown()
+
+  def shutdown
     if @consumer
-      @consumer.shutdown()
+      @consumer.shutdown
     end
     if @executor
-      @executor.shutdown()
+      @executor.shutdown
     end
     @running = false
   end
 
-  public
-  def run(a_numThreads, a_queue)
+  def run(a_num_threads, a_queue)
     begin
       if @auto_offset_reset == 'smallest'
         Java::kafka::utils::ZkUtils.maybeDeletePath(@zk_connect, "/consumers/#{@group_id}")
       end
 
-      @consumer = Java::kafka::consumer::Consumer.createJavaConsumerConnector(createConsumerConfig())
+      @consumer = Java::kafka::consumer::Consumer.createJavaConsumerConnector(create_consumer_config)
     rescue ZkException => e
       raise KafkaError.new(e), "Got ZkException: #{e}"
     end
-    topicCountMap = java.util.HashMap.new()
-    thread_value = a_numThreads.to_java Java::int
-    topicCountMap.put(@topic, thread_value)
-    consumerMap = @consumer.createMessageStreams(topicCountMap)
-    streams = Array.new(consumerMap[@topic])
+    topic_count_map = java.util.HashMap.new
+    thread_value = a_num_threads.to_java Java::int
+    topic_count_map.put(@topic, thread_value)
+    consumer_map = @consumer.createMessageStreams(topic_count_map)
+    streams = Array.new(consumer_map[@topic])
 
-    @executor = Executors.newFixedThreadPool(a_numThreads)
+    @executor = Executors.newFixedThreadPool(a_num_threads)
     @executor_submit = @executor.java_method(:submit, [Java::JavaLang::Runnable.java_class])
 
-    threadNumber = 0
-    for stream in streams
-      @executor_submit.call(Kafka::Consumer.new(stream, threadNumber, a_queue, @consumer_restart_on_error, @consumer_restart_sleep_ms))
-      threadNumber += 1
+    thread_number = 0
+    streams.each do |stream|
+      @executor_submit.call(Kafka::Consumer.new(stream, thread_number, a_queue, @consumer_restart_on_error, @consumer_restart_sleep_ms))
+      thread_number += 1
     end
     @running = true
   end
 
-  public
   def running?
     @running
   end
 
   private
-  def createConsumerConfig()
-    properties = java.util.Properties.new()
-    properties.put("zookeeper.connect", @zk_connect)
-    properties.put("group.id", @group_id)
-    properties.put("zookeeper.connection.timeout.ms", @zk_connect_timeout)
-    properties.put("zookeeper.session.timeout.ms", @zk_session_timeout)
-    properties.put("zookeeper.sync.time.ms", @zk_sync_time)
-    properties.put("auto.commit.interval.ms", @auto_commit_interval)
-    properties.put("auto.offset.reset", @auto_offset_reset)
-    properties.put("rebalance.max.retries", @rebalance_max_retries)
-    properties.put("rebalance.backoff.ms", @rebalance_backoff_ms)
-    properties.put("socket.timeout.ms", @socket_timeout_ms)
-    properties.put("socket.receive.buffer.bytes", @socket_receive_buffer_bytes)
-    properties.put("fetch.message.max.bytes", @fetch_message_max_bytes)
-    properties.put("auto.commit.enable", @auto_commit_enable)
-    properties.put("queued.max.message.chunks", @queued_max_message_chunks)
-    properties.put("fetch.min.bytes", @fetch_min_bytes)
-    properties.put("fetch.wait.max.ms", @fetch_wait_max_ms)
-    properties.put("refresh.leader.backoff.ms", @refresh_leader_backoff_ms)
-    properties.put("consumer.timeout.ms", @consumer_timeout_ms)
+
+  def validate_required_arguments(options={})
+    [:zk_connect, :group_id, :topic_id].each do |opt|
+      raise(ArgumentError, "#{opt} is required.") unless options[opt]
+    end
+  end
+
+  def create_consumer_config
+    properties = java.util.Properties.new
+    properties.put('zookeeper.connect', @zk_connect)
+    properties.put('group.id', @group_id)
+    properties.put('zookeeper.connection.timeout.ms', @zk_connect_timeout)
+    properties.put('zookeeper.session.timeout.ms', @zk_session_timeout)
+    properties.put('zookeeper.sync.time.ms', @zk_sync_time)
+    properties.put('auto.commit.interval.ms', @auto_commit_interval)
+    properties.put('auto.offset.reset', @auto_offset_reset)
+    properties.put('rebalance.max.retries', @rebalance_max_retries)
+    properties.put('rebalance.backoff.ms', @rebalance_backoff_ms)
+    properties.put('socket.timeout.ms', @socket_timeout_ms)
+    properties.put('socket.receive.buffer.bytes', @socket_receive_buffer_bytes)
+    properties.put('fetch.message.max.bytes', @fetch_message_max_bytes)
+    properties.put('auto.commit.enable', @auto_commit_enable)
+    properties.put('queued.max.message.chunks', @queued_max_message_chunks)
+    properties.put('fetch.min.bytes', @fetch_min_bytes)
+    properties.put('fetch.wait.max.ms', @fetch_wait_max_ms)
+    properties.put('refresh.leader.backoff.ms', @refresh_leader_backoff_ms)
+    properties.put('consumer.timeout.ms', @consumer_timeout_ms)
     unless @consumer_id.nil?
       properties.put('consumer.id', @consumer_id)
     end
-    return Java::kafka::consumer::ConsumerConfig.new(properties)
+    Java::kafka::consumer::ConsumerConfig.new(properties)
   end
 end